For example, normalize `jane.doe@gmail.com` to `janedoe@gmail.com`. + 2. The plus sign (`+` (ASCII code 43)) and all subsequent characters.
For example, normalize `janedoe+home@gmail.com` to `janedoe@gmail.com`. + +## Email Address Hash Encoding + +An email hash is a Base64-encoded SHA-256 hash of a normalized email address. The email address is first normalized, then hashed using the SHA-256 hashing algorithm, and then the resulting bytes of the hash value are encoded using Base64 encoding. Note that the bytes of the hash value are encoded, not the hex-encoded string representation. + +| Type | Example | Comments and Usage | +| :--- | :--- | :--- | +| Normalized email address | `user@example.com` | Normalization is always the first step. | +| SHA-256 hash of normalized email address | `b4c9a289323b21a01c3e940f150eb9b8c542587f1abfd8f0e1cc1ffc5e475514` | This 64-character string is a hex-encoded representation of the 32-byte SHA-256.| +| Hex to Base64 SHA-256 encoding of normalized email address | `tMmiiTI7IaAcPpQPFQ65uMVCWH8av9jw4cwf/F5HVRQ=` | This 44-character string is a Base64-encoded representation of the 32-byte SHA-256.
WARNING: The SHA-256 hash string in the example above is a hex-encoded representation of the hash value. You must Base64-encode the raw bytes of the hash or use a Base64 encoder that takes a hex-encoded value as input.
Use this encoding for `email_hash` values sent in the request body. | + +>WARNING: When applying Base64 encoding, be sure to Base64-encode the raw bytes of the hash or use a Base64 encoder that takes a hex-encoded value as input. + +## Phone Number Normalization + +If you send unhashed phone numbers to the UID2 Operator Service, the service normalizes the phone numbers and then hashes them. If you want to hash the phone numbers yourself before sending them, you must normalize them before you hash them. + +> IMPORTANT: Normalization before hashing ensures that the generated UID2 value will always be the same, so that the data can be matched. If you do not normalize before hashing, this might result in a different UID2, reducing the effectiveness of targeted advertising. + +Here's what you need to know about phone number normalization rules: + +- The UID2 Operator accepts phone numbers in the [E.164](https://en.wikipedia.org/wiki/E.164) format, which is the international phone number format that ensures global uniqueness. +- E.164 phone numbers can have a maximum of 15 digits. +- Normalized E.164 phone numbers use the following syntax, with no spaces, hyphens, parentheses, or other special characters:
+ `[+] [country code] [subscriber number including area code]` + Examples: + - US: `1 (123) 456-7890` is normalized to `+11234567890`. + - Singapore: `65 1243 5678` is normalized to `+6512345678`. + - Sydney, Australia: `(02) 1234 5678` is normalized to drop the leading zero for the city plus include the country code: `+61212345678`. + +## Phone Number Hash Encoding + +A phone number hash is a Base64-encoded SHA-256 hash of a normalized phone number. The phone number is first normalized, then hashed using the SHA-256 hashing algorithm, and the resulting hex value is encoded using Base64 encoding. + +The example below shows a simple input phone number, and the result as each step is applied to arrive at a secure, opaque, URL-safe value. + +| Type | Example | Comments and Usage | +| :--- | :--- | :--- | +| Normalized phone number | `+12345678901` | Normalization is always the first step. | +| SHA-256 hash of normalized phone number | `10e6f0b47054a83359477dcb35231db6de5c69fb1816e1a6b98e192de9e5b9ee` |This 64-character string is a hex-encoded representation of the 32-byte SHA-256. | +| Hex to Base64 SHA-256 encoding of normalized and hashed phone number | `EObwtHBUqDNZR33LNSMdtt5cafsYFuGmuY4ZLenlue4=` | This 44-character string is a Base64-encoded representation of the 32-byte SHA-256.
NOTE: The SHA-256 hash is a hexadecimal value. You must use a Base64 encoder that takes a hex value as input. Use this encoding for `phone_hash` values sent in the request body. | + +>WARNING: When applying Base64 encoding, be sure to use a function that takes a hex value as input. If you use a function that takes text as input, the result is a longer string which is invalid for the purposes of UID2. diff --git a/modules/uid2IdSystem_shared.js b/modules/uid2IdSystem_shared.js index 0f6894a9d3e..acc440eafc5 100644 --- a/modules/uid2IdSystem_shared.js +++ b/modules/uid2IdSystem_shared.js @@ -1,4 +1,7 @@ /* eslint-disable no-console */ +import { ajax } from '../src/ajax.js'; +import { cyrb53Hash } from '../src/utils.js'; + export const Uid2CodeVersion = '1.1'; function isValidIdentity(identity) { @@ -13,6 +16,7 @@ export class Uid2ApiClient { this._logInfo = logInfo; this._logWarn = logWarn; } + createArrayBuffer(text) { const arrayBuffer = new Uint8Array(text.length); for (let i = 0; i < text.length; i++) { @@ -36,49 +40,58 @@ export class Uid2ApiClient { } callRefreshApi(refreshDetails) { const url = this._baseUrl + '/v2/token/refresh'; - const req = new XMLHttpRequest(); - req.overrideMimeType('text/plain'); - req.open('POST', url, true); - req.setRequestHeader('X-UID2-Client-Version', this._clientVersion); let resolvePromise; let rejectPromise; const promise = new Promise((resolve, reject) => { resolvePromise = resolve; rejectPromise = reject; }); - req.onreadystatechange = () => { - if (req.readyState !== req.DONE) { return; } - try { - if (!refreshDetails.refresh_response_key || req.status !== 200) { - this._logInfo('Error status OR no response decryption key available, assuming unencrypted JSON'); - const response = JSON.parse(req.responseText); + this._logInfo('Sending refresh request', refreshDetails); + ajax(url, { + success: (responseText) => { + try { + if (!refreshDetails.refresh_response_key) { + this._logInfo('No response decryption key available, assuming unencrypted JSON'); + const response = JSON.parse(responseText); + const result = this.ResponseToRefreshResult(response); + if (typeof result === 'string') { rejectPromise(result); } else { resolvePromise(result); } + } else { + this._logInfo('Decrypting refresh API response'); + const encodeResp = this.createArrayBuffer(atob(responseText)); + window.crypto.subtle.importKey('raw', this.createArrayBuffer(atob(refreshDetails.refresh_response_key)), { name: 'AES-GCM' }, false, ['decrypt']).then((key) => { + this._logInfo('Imported decryption key') + // returns the symmetric key + window.crypto.subtle.decrypt({ + name: 'AES-GCM', + iv: encodeResp.slice(0, 12), + tagLength: 128, // The tagLength you used to encrypt (if any) + }, key, encodeResp.slice(12)).then((decrypted) => { + const decryptedResponse = String.fromCharCode(...new Uint8Array(decrypted)); + this._logInfo('Decrypted to:', decryptedResponse); + const response = JSON.parse(decryptedResponse); + const result = this.ResponseToRefreshResult(response); + if (typeof result === 'string') { rejectPromise(result); } else { resolvePromise(result); } + }, (reason) => this._logWarn(`Call to UID2 API failed`, reason)); + }, (reason) => this._logWarn(`Call to UID2 API failed`, reason)); + } + } catch (_err) { + rejectPromise(responseText); + } + }, + error: (error, xhr) => { + try { + this._logInfo('Error status, assuming unencrypted JSON'); + const response = JSON.parse(xhr.responseText); const result = this.ResponseToRefreshResult(response); if (typeof result === 'string') { rejectPromise(result); } else { resolvePromise(result); } - } else { - this._logInfo('Decrypting refresh API response'); - const encodeResp = this.createArrayBuffer(atob(req.responseText)); - window.crypto.subtle.importKey('raw', this.createArrayBuffer(atob(refreshDetails.refresh_response_key)), { name: 'AES-GCM' }, false, ['decrypt']).then((key) => { - this._logInfo('Imported decryption key') - // returns the symmetric key - window.crypto.subtle.decrypt({ - name: 'AES-GCM', - iv: encodeResp.slice(0, 12), - tagLength: 128, // The tagLength you used to encrypt (if any) - }, key, encodeResp.slice(12)).then((decrypted) => { - const decryptedResponse = String.fromCharCode(...new Uint8Array(decrypted)); - this._logInfo('Decrypted to:', decryptedResponse); - const response = JSON.parse(decryptedResponse); - const result = this.ResponseToRefreshResult(response); - if (typeof result === 'string') { rejectPromise(result); } else { resolvePromise(result); } - }, (reason) => this._logWarn(`Call to UID2 API failed`, reason)); - }, (reason) => this._logWarn(`Call to UID2 API failed`, reason)); + } catch (_e) { + rejectPromise(error) } - } catch (err) { - rejectPromise(err); } - }; - this._logInfo('Sending refresh request', refreshDetails); - req.send(refreshDetails.refresh_token); + }, refreshDetails.refresh_token, { method: 'POST', + customHeaders: { + 'X-UID2-Client-Version': this._clientVersion + } }); return promise; } } @@ -160,18 +173,507 @@ function refreshTokenAndStore(baseUrl, token, clientId, storageManager, _logInfo originalToken: token, latestToken: response.identity, }; + let storedTokens = storageManager.getStoredValueWithFallback(); + if (storedTokens?.originalIdentity) tokens.originalIdentity = storedTokens.originalIdentity; storageManager.storeValue(tokens); return tokens; }); } +let clientSideTokenGenerator; +if (FEATURES.UID2_CSTG) { + const SERVER_PUBLIC_KEY_PREFIX_LENGTH = 9; + + clientSideTokenGenerator = { + isCSTGOptionsValid(maybeOpts, _logWarn) { + if (typeof maybeOpts !== 'object' || maybeOpts === null) { + _logWarn('CSTG opts must be an object'); + return false; + } + + const opts = maybeOpts; + if (typeof opts.serverPublicKey !== 'string') { + _logWarn('CSTG opts.serverPublicKey must be a string'); + return false; + } + const serverPublicKeyPrefix = /^UID2-X-[A-Z]-.+/; + if (!serverPublicKeyPrefix.test(opts.serverPublicKey)) { + _logWarn( + `CSTG opts.serverPublicKey must match the regular expression ${serverPublicKeyPrefix}` + ); + return false; + } + // We don't do any further validation of the public key, as we will find out + // later if it's valid by using importKey. + + if (typeof opts.subscriptionId !== 'string') { + _logWarn('CSTG opts.subscriptionId must be a string'); + return false; + } + if (opts.subscriptionId.length === 0) { + _logWarn('CSTG opts.subscriptionId is empty'); + return false; + } + return true; + }, + + getValidIdentity(opts, _logWarn) { + if (opts.emailHash) { + if (!UID2DiiNormalization.isBase64Hash(opts.emailHash)) { + _logWarn('CSTG opts.emailHash is invalid'); + return; + } + return { email_hash: opts.emailHash }; + } + + if (opts.phoneHash) { + if (!UID2DiiNormalization.isBase64Hash(opts.phoneHash)) { + _logWarn('CSTG opts.phoneHash is invalid'); + return; + } + return { phone_hash: opts.phoneHash }; + } + + if (opts.email) { + const normalizedEmail = UID2DiiNormalization.normalizeEmail(opts.email); + if (normalizedEmail === undefined) { + _logWarn('CSTG opts.email is invalid'); + return; + } + return { email: normalizedEmail }; + } + + if (opts.phone) { + if (!UID2DiiNormalization.isNormalizedPhone(opts.phone)) { + _logWarn('CSTG opts.phone is invalid'); + return; + } + return { phone: opts.phone }; + } + }, + + isStoredTokenInvalid(cstgIdentity, storedTokens, _logInfo, _logWarn) { + if (storedTokens) { + const identity = Object.values(cstgIdentity)[0]; + if (!this.isStoredTokenFromSameIdentity(storedTokens, identity)) { + _logInfo( + 'CSTG supplied new identity - ignoring stored value.', + storedTokens.originalIdentity, + cstgIdentity + ); + // Stored token wasn't originally sourced from the provided identity - ignore the stored value. A new user has logged in? + return true; + } + } + return false; + }, + + async generateTokenAndStore( + baseUrl, + cstgOpts, + cstgIdentity, + storageManager, + _logInfo, + _logWarn + ) { + _logInfo('UID2 cstg opts provided: ', JSON.stringify(cstgOpts)); + const client = new UID2CstgApiClient( + { baseUrl, cstg: cstgOpts }, + _logInfo, + _logWarn + ); + const response = await client.generateToken(cstgIdentity); + _logInfo('CSTG endpoint responded with:', response); + const tokens = { + originalIdentity: this.encodeOriginalIdentity(cstgIdentity), + latestToken: response.identity, + }; + storageManager.storeValue(tokens); + return tokens; + }, + + isStoredTokenFromSameIdentity(storedTokens, identity) { + if (!storedTokens.originalIdentity) return false; + return ( + cyrb53Hash(identity, storedTokens.originalIdentity.salt) === + storedTokens.originalIdentity.identity + ); + }, + + encodeOriginalIdentity(identity) { + const identityValue = Object.values(identity)[0]; + const salt = Math.floor(Math.random() * Math.pow(2, 32)); + return { + identity: cyrb53Hash(identityValue, salt), + salt, + }; + }, + }; + + class UID2DiiNormalization { + static EMAIL_EXTENSION_SYMBOL = '+'; + static EMAIL_DOT = '.'; + static GMAIL_DOMAIN = 'gmail.com'; + + static isBase64Hash(value) { + if (!(value && value.length === 44)) { + return false; + } + + try { + return btoa(atob(value)) === value; + } catch (err) { + return false; + } + } + + static isNormalizedPhone(phone) { + return /^\+[0-9]{10,15}$/.test(phone); + } + + static normalizeEmail(email) { + if (!email || !email.length) return; + + const parsedEmail = email.trim().toLowerCase(); + if (parsedEmail.indexOf(' ') > 0) return; + + const emailParts = this.splitEmailIntoAddressAndDomain(parsedEmail); + if (!emailParts) return; + + const { address, domain } = emailParts; + + const emailIsGmail = this.isGmail(domain); + const parsedAddress = this.normalizeAddressPart( + address, + emailIsGmail, + emailIsGmail + ); + + return parsedAddress ? `${parsedAddress}@${domain}` : undefined; + } + + static splitEmailIntoAddressAndDomain(email) { + const parts = email.split('@'); + if ( + parts.length !== 2 || + parts.some((part) => part === '') + ) { return; } + + return { + address: parts[0], + domain: parts[1], + }; + } + + static isGmail(domain) { + return domain === this.GMAIL_DOMAIN; + } + + static dropExtension(address, extensionSymbol = this.EMAIL_EXTENSION_SYMBOL) { + return address.split(extensionSymbol)[0]; + } + + static normalizeAddressPart(address, shouldRemoveDot, shouldDropExtension) { + let parsedAddress = address; + if (shouldRemoveDot) { parsedAddress = parsedAddress.replaceAll(this.EMAIL_DOT, ''); } + if (shouldDropExtension) parsedAddress = this.dropExtension(parsedAddress); + return parsedAddress; + } + } + + class UID2CstgApiClient { + constructor(opts, logInfo, logWarn) { + this._baseUrl = opts.baseUrl; + this._serverPublicKey = opts.cstg.serverPublicKey; + this._subscriptionId = opts.cstg.subscriptionId; + this._logInfo = logInfo; + this._logWarn = logWarn; + } + + hasStatusResponse(response) { + return typeof response === 'object' && response && response.status; + } + + isCstgApiSuccessResponse(response) { + return ( + this.hasStatusResponse(response) && + response.status === 'success' && + isValidIdentity(response.body) + ); + } + + isCstgApiClientErrorResponse(response) { + return ( + this.hasStatusResponse(response) && + response.status === 'client_error' && + typeof response.message === 'string' + ); + } + + isCstgApiForbiddenResponse(response) { + return ( + this.hasStatusResponse(response) && + response.status === 'invalid_http_origin' && + typeof response.message === 'string' + ); + } + + stripPublicKeyPrefix(serverPublicKey) { + return serverPublicKey.substring(SERVER_PUBLIC_KEY_PREFIX_LENGTH); + } + + async generateCstgRequest(cstgIdentity) { + if ('email_hash' in cstgIdentity || 'phone_hash' in cstgIdentity) { + return cstgIdentity; + } + if ('email' in cstgIdentity) { + const emailHash = await UID2CstgCrypto.hash(cstgIdentity.email); + return { email_hash: emailHash }; + } + if ('phone' in cstgIdentity) { + const phoneHash = await UID2CstgCrypto.hash(cstgIdentity.phone); + return { phone_hash: phoneHash }; + } + } + + async generateToken(cstgIdentity) { + const request = await this.generateCstgRequest(cstgIdentity); + this._logInfo('Building CSTG request for', request); + const box = await UID2CstgBox.build( + this.stripPublicKeyPrefix(this._serverPublicKey) + ); + const encoder = new TextEncoder(); + const now = Date.now(); + const { iv, ciphertext } = await box.encrypt( + encoder.encode(JSON.stringify(request)), + encoder.encode(JSON.stringify([now])) + ); + + const exportedPublicKey = await UID2CstgCrypto.exportPublicKey( + box.clientPublicKey + ); + const requestBody = { + payload: UID2CstgCrypto.bytesToBase64(new Uint8Array(ciphertext)), + iv: UID2CstgCrypto.bytesToBase64(new Uint8Array(iv)), + public_key: UID2CstgCrypto.bytesToBase64( + new Uint8Array(exportedPublicKey) + ), + timestamp: now, + subscription_id: this._subscriptionId, + }; + return this.callCstgApi(requestBody, box); + } + + async callCstgApi(requestBody, box) { + const url = this._baseUrl + '/v2/token/client-generate'; + let resolvePromise; + let rejectPromise; + const promise = new Promise((resolve, reject) => { + resolvePromise = resolve; + rejectPromise = reject; + }); + + this._logInfo('Sending CSTG request', requestBody); + ajax( + url, + { + success: async (responseText, xhr) => { + try { + const encodedResp = UID2CstgCrypto.base64ToBytes(responseText); + const decrypted = await box.decrypt( + encodedResp.slice(0, 12), + encodedResp.slice(12) + ); + const decryptedResponse = new TextDecoder().decode(decrypted); + const response = JSON.parse(decryptedResponse); + if (this.isCstgApiSuccessResponse(response)) { + resolvePromise({ + status: 'success', + identity: response.body, + }); + } else { + // A 200 should always be a success response. + // Something has gone wrong. + rejectPromise( + `API error: Response body was invalid for HTTP status 200: ${decryptedResponse}` + ); + } + } catch (err) { + rejectPromise(err); + } + }, + error: (error, xhr) => { + try { + if (xhr.status === 400) { + const response = JSON.parse(xhr.responseText); + if (this.isCstgApiClientErrorResponse(response)) { + rejectPromise(`Client error: ${response.message}`); + } else { + // A 400 should always be a client error. + // Something has gone wrong. + rejectPromise( + `API error: Response body was invalid for HTTP status 400: ${xhr.responseText}` + ); + } + } else if (xhr.status === 403) { + const response = JSON.parse(xhr.responseText); + if (this.isCstgApiForbiddenResponse(xhr)) { + rejectPromise(`Forbidden: ${response.message}`); + } else { + // A 403 should always be a forbidden response. + // Something has gone wrong. + rejectPromise( + `API error: Response body was invalid for HTTP status 403: ${xhr.responseText}` + ); + } + } else { + rejectPromise( + `API error: Unexpected HTTP status ${xhr.status}: ${error}` + ); + } + } catch (_e) { + rejectPromise(error); + } + }, + }, + JSON.stringify(requestBody), + { method: 'POST' } + ); + return promise; + } + } + + class UID2CstgBox { + static _namedCurve = 'P-256'; + constructor(clientPublicKey, sharedKey) { + this._clientPublicKey = clientPublicKey; + this._sharedKey = sharedKey; + } + + static async build(serverPublicKey) { + const clientKeyPair = await UID2CstgCrypto.generateKeyPair( + UID2CstgBox._namedCurve + ); + const importedServerPublicKey = await UID2CstgCrypto.importPublicKey( + serverPublicKey, + this._namedCurve + ); + const sharedKey = await UID2CstgCrypto.deriveKey( + importedServerPublicKey, + clientKeyPair.privateKey + ); + return new UID2CstgBox(clientKeyPair.publicKey, sharedKey); + } + + async encrypt(plaintext, additionalData) { + const iv = window.crypto.getRandomValues(new Uint8Array(12)); + const ciphertext = await window.crypto.subtle.encrypt( + { + name: 'AES-GCM', + iv, + additionalData, + }, + this._sharedKey, + plaintext + ); + return { iv, ciphertext }; + } + + async decrypt(iv, ciphertext) { + return window.crypto.subtle.decrypt( + { + name: 'AES-GCM', + iv, + }, + this._sharedKey, + ciphertext + ); + } + + get clientPublicKey() { + return this._clientPublicKey; + } + } + + class UID2CstgCrypto { + static base64ToBytes(base64) { + const binString = atob(base64); + return Uint8Array.from(binString, (m) => m.codePointAt(0)); + } + + static bytesToBase64(bytes) { + const binString = Array.from(bytes, (x) => String.fromCodePoint(x)).join( + '' + ); + return btoa(binString); + } + + static async generateKeyPair(namedCurve) { + const params = { + name: 'ECDH', + namedCurve: namedCurve, + }; + return window.crypto.subtle.generateKey(params, false, ['deriveKey']); + } + + static async importPublicKey(publicKey, namedCurve) { + const params = { + name: 'ECDH', + namedCurve: namedCurve, + }; + return window.crypto.subtle.importKey( + 'spki', + this.base64ToBytes(publicKey), + params, + false, + [] + ); + } + + static exportPublicKey(publicKey) { + return window.crypto.subtle.exportKey('spki', publicKey); + } + + static async deriveKey(serverPublicKey, clientPrivateKey) { + return window.crypto.subtle.deriveKey( + { + name: 'ECDH', + public: serverPublicKey, + }, + clientPrivateKey, + { + name: 'AES-GCM', + length: 256, + }, + false, + ['encrypt', 'decrypt'] + ); + } + + static async hash(value) { + const hash = await window.crypto.subtle.digest( + 'SHA-256', + new TextEncoder().encode(value) + ); + return this.bytesToBase64(new Uint8Array(hash)); + } + } +} + export function Uid2GetId(config, prebidStorageManager, _logInfo, _logWarn) { let suppliedToken = null; const preferLocalStorage = (config.storage !== 'cookie'); const storageManager = new Uid2StorageManager(prebidStorageManager, preferLocalStorage, config.internalStorage, _logInfo); _logInfo(`Module is using ${preferLocalStorage ? 'local storage' : 'cookies'} for internal storage.`); - if (config.paramToken) { + const isCstgEnabled = + clientSideTokenGenerator && + clientSideTokenGenerator.isCSTGOptionsValid(config.cstg, _logWarn); + if (isCstgEnabled) { + _logInfo(`Module is using client-side token generation.`); + // Ignores config.paramToken and config.serverCookieName if any is provided + suppliedToken = null; + } else if (config.paramToken) { suppliedToken = config.paramToken; _logInfo('Read token from params', suppliedToken); } else if (config.serverCookieName) { @@ -184,7 +686,7 @@ export function Uid2GetId(config, prebidStorageManager, _logInfo, _logWarn) { if (storedTokens && typeof storedTokens === 'string') { // Stored value is a plain token - if no token is supplied, just use the stored value. - if (!suppliedToken) { + if (!suppliedToken && !isCstgEnabled) { _logInfo('Returning legacy cookie value.'); return { id: storedTokens }; } @@ -200,11 +702,31 @@ export function Uid2GetId(config, prebidStorageManager, _logInfo, _logWarn) { storedTokens = null; } } - // At this point, any legacy values or superseded stored tokens have been nulled out. + + if (FEATURES.UID2_CSTG && isCstgEnabled) { + const cstgIdentity = clientSideTokenGenerator.getValidIdentity(config.cstg, _logWarn); + if (cstgIdentity) { + if (storedTokens && clientSideTokenGenerator.isStoredTokenInvalid(cstgIdentity, storedTokens, _logInfo, _logWarn)) { + storedTokens = null; + } + + if (!storedTokens || Date.now() > storedTokens.latestToken.refresh_expires) { + const promise = clientSideTokenGenerator.generateTokenAndStore(config.apiBaseUrl, config.cstg, cstgIdentity, storageManager, _logInfo, _logWarn); + _logInfo('Generate token using CSTG'); + return { callback: (cb) => { + promise.then((result) => { + _logInfo('Token generation responded, passing the new token on.', result); + cb(result); + }); + } }; + } + } + } + const useSuppliedToken = !(storedTokens?.latestToken) || (suppliedToken && suppliedToken.identity_expires > storedTokens.latestToken.identity_expires); const newestAvailableToken = useSuppliedToken ? suppliedToken : storedTokens.latestToken; _logInfo('UID2 module selected latest token', useSuppliedToken, newestAvailableToken); - if (!newestAvailableToken || Date.now() > newestAvailableToken.refresh_expires) { + if ((!newestAvailableToken || Date.now() > newestAvailableToken.refresh_expires)) { _logInfo('Newest available token is expired and not refreshable.'); return { id: null }; } @@ -227,6 +749,21 @@ export function Uid2GetId(config, prebidStorageManager, _logInfo, _logWarn) { originalToken: suppliedToken ?? storedTokens?.originalToken, latestToken: newestAvailableToken, }; + if (FEATURES.UID2_CSTG && isCstgEnabled) { + tokens.originalIdentity = storedTokens?.originalIdentity; + } storageManager.storeValue(tokens); return { id: tokens }; } + +export function extractIdentityFromParams(params) { + const keysToCheck = ['emailHash', 'phoneHash', 'email', 'phone']; + + for (let key of keysToCheck) { + if (params.hasOwnProperty(key)) { + return { [key]: params[key] }; + } + } + + return {}; +} diff --git a/modules/underdogmediaBidAdapter.js b/modules/underdogmediaBidAdapter.js index 7561cdb60de..54b74c7ccd4 100644 --- a/modules/underdogmediaBidAdapter.js +++ b/modules/underdogmediaBidAdapter.js @@ -4,7 +4,6 @@ import { getWindowSelf, getWindowTop, isGptPubadsDefined, - isSlotMatchingAdUnitCode, logInfo, logMessage, logWarn, @@ -12,6 +11,7 @@ import { } from '../src/utils.js'; import {config} from '../src/config.js'; import {registerBidder} from '../src/adapters/bidderFactory.js'; +import {isSlotMatchingAdUnitCode} from '../libraries/gptUtils/gptUtils.js'; const BIDDER_CODE = 'underdogmedia'; const UDM_ADAPTER_VERSION = '7.30V'; @@ -71,7 +71,7 @@ export const spec = { let data = { dt: 10, gdpr: {}, - pbTimeout: config.getConfig('bidderTimeout'), + pbTimeout: +config.getConfig('bidderTimeout') || 3001, // KP: convert to number and if NaN we default to 3001. Particular value to let us know that there was a problem in converting pbTimeout pbjsVersion: prebidVersion, placements: [], ref: deepAccess(bidderRequest, 'refererInfo.page') ? bidderRequest.refererInfo.page : undefined, diff --git a/modules/undertoneBidAdapter.js b/modules/undertoneBidAdapter.js index 9dcbefd374b..c7e8102ffc9 100644 --- a/modules/undertoneBidAdapter.js +++ b/modules/undertoneBidAdapter.js @@ -139,6 +139,7 @@ export const spec = { domain: domain, placementId: bidReq.params.placementId != undefined ? bidReq.params.placementId : null, publisherId: bidReq.params.publisherId, + gpid: deepAccess(bidReq, 'ortb2Imp.ext.gpid', deepAccess(bidReq, 'ortb2Imp.ext.data.pbadslot', '')), sizes: bidReq.sizes, params: bidReq.params }; diff --git a/modules/unicornBidAdapter.js b/modules/unicornBidAdapter.js index 66aaf4a17e5..429ba8f60ba 100644 --- a/modules/unicornBidAdapter.js +++ b/modules/unicornBidAdapter.js @@ -87,10 +87,33 @@ function buildOpenRtbBidRequestPayload(validBidRequests, bidderRequest) { accountId: deepAccess(validBidRequests[0], 'params.accountId') } }; + const eids = initializeEids(validBidRequests[0]); + if (eids.length > 0) { + request.user.eids = eids; + } + logInfo('[UNICORN] OpenRTB Formatted Request:', request); return JSON.stringify(request); } +const initializeEids = (bidRequest) => { + let eids = []; + + let id5 = deepAccess(bidRequest, 'userId.id5id.uid'); + if (id5) { + eids.push({ + source: 'id5-sync.com', + uids: [ + { + id: id5 + } + ] + }); + } + + return eids; +} + const interpretResponse = (serverResponse, request) => { logInfo('[UNICORN] interpretResponse.serverResponse:', serverResponse); logInfo('[UNICORN] interpretResponse.request:', request); diff --git a/modules/unrulyBidAdapter.js b/modules/unrulyBidAdapter.js index d893bfd3038..b825003f36f 100644 --- a/modules/unrulyBidAdapter.js +++ b/modules/unrulyBidAdapter.js @@ -56,6 +56,12 @@ const RemoveDuplicateSizes = (validBid) => { } }; +const ConfigureProtectedAudience = (validBid, protectedAudienceEnabled) => { + if (!protectedAudienceEnabled && validBid.ortb2Imp && validBid.ortb2Imp.ext) { + delete validBid.ortb2Imp.ext.ae; + } +} + const getRequests = (conf, validBidRequests, bidderRequest) => { const {bids, bidderRequestId, bidderCode, ...bidderRequestData} = bidderRequest; const invalidBidsCount = bidderRequest.bids.length - validBidRequests.length; @@ -65,6 +71,7 @@ const getRequests = (conf, validBidRequests, bidderRequest) => { const currSiteId = validBid.params.siteId; addBidFloorInfo(validBid); RemoveDuplicateSizes(validBid); + ConfigureProtectedAudience(validBid, conf.protectedAudienceEnabled); requestBySiteId[currSiteId] = requestBySiteId[currSiteId] || []; requestBySiteId[currSiteId].push(validBid); }); @@ -73,7 +80,14 @@ const getRequests = (conf, validBidRequests, bidderRequest) => { Object.keys(requestBySiteId).forEach((key) => { let data = { - bidderRequest: Object.assign({}, {bids: requestBySiteId[key], invalidBidsCount, ...bidderRequestData}) + bidderRequest: Object.assign({}, + { + bids: requestBySiteId[key], + invalidBidsCount, + prebidVersion: '$prebid.version$', + ...bidderRequestData + } + ) }; request.push(Object.assign({}, {data, ...conf})); @@ -206,21 +220,49 @@ export const adapter = { endPoint = deepAccess(validBidRequests[0], 'params.endpoint') || endPoint; } - const url = endPoint; - const method = 'POST'; - const options = {contentType: 'application/json'}; - return getRequests({url, method, options}, validBidRequests, bidderRequest); + return getRequests({ + 'url': endPoint, + 'method': 'POST', + 'options': { + 'contentType': 'application/json' + }, + 'protectedAudienceEnabled': bidderRequest.fledgeEnabled + }, validBidRequests, bidderRequest); }, - interpretResponse: function (serverResponse = {}) { + interpretResponse: function (serverResponse) { + if (!(serverResponse && serverResponse.body && (serverResponse.body.auctionConfigs || serverResponse.body.bids))) { + return []; + } + const serverResponseBody = serverResponse.body; + let bids = []; + let fledgeAuctionConfigs = null; + if (serverResponseBody.bids.length) { + bids = handleBidResponseByMediaType(serverResponseBody.bids); + } - const noBidsResponse = []; - const isInvalidResponse = !serverResponseBody || !serverResponseBody.bids; + if (serverResponseBody.auctionConfigs) { + let auctionConfigs = serverResponseBody.auctionConfigs; + let bidIdList = Object.keys(auctionConfigs); + if (bidIdList.length) { + bidIdList.forEach((bidId) => { + fledgeAuctionConfigs = [{ + 'bidId': bidId, + 'config': auctionConfigs[bidId] + }]; + }) + } + } - return isInvalidResponse - ? noBidsResponse - : handleBidResponseByMediaType(serverResponseBody.bids); + if (!fledgeAuctionConfigs) { + return bids; + } + + return { + bids, + fledgeAuctionConfigs + }; } }; diff --git a/modules/userId/eids.js b/modules/userId/eids.js index dc362b41136..e5f7e3b8fb2 100644 --- a/modules/userId/eids.js +++ b/modules/userId/eids.js @@ -1,4 +1,4 @@ -import {deepAccess, isFn, isPlainObject, isStr} from '../../src/utils.js'; +import {deepAccess, deepClone, isFn, isPlainObject, isStr} from '../../src/utils.js'; export const EID_CONFIG = new Map(); @@ -32,34 +32,23 @@ function createEidObject(userIdData, subModuleKey) { return null; } -// this function will generate eids array for all available IDs in bidRequest.userId -// this function will be called by userId module -// if any adapter does not want any particular userId to be passed then adapter can use Array.filter(e => e.source != 'tdid') export function createEidsArray(bidRequestUserId) { - let eids = []; - - for (const subModuleKey in bidRequestUserId) { - if (bidRequestUserId.hasOwnProperty(subModuleKey)) { - if (subModuleKey === 'pubProvidedId') { - eids = eids.concat(bidRequestUserId['pubProvidedId']); - } else if (Array.isArray(bidRequestUserId[subModuleKey])) { - bidRequestUserId[subModuleKey].forEach((config, index, arr) => { - const eid = createEidObject(config, subModuleKey); - - if (eid) { - eids.push(eid); - } - }) - } else { - const eid = createEidObject(bidRequestUserId[subModuleKey], subModuleKey); - if (eid) { - eids.push(eid); - } - } + const allEids = {}; + function collect(eid) { + const key = JSON.stringify([eid.source?.toLowerCase(), eid.ext]); + if (allEids.hasOwnProperty(key)) { + allEids[key].uids.push(...eid.uids); + } else { + allEids[key] = eid; } } - return eids; + Object.entries(bidRequestUserId).forEach(([name, values]) => { + values = Array.isArray(values) ? values : [values]; + const eids = name === 'pubProvidedId' ? deepClone(values) : values.map(value => createEidObject(value, name)); + eids.filter(eid => eid != null).forEach(collect); + }) + return Object.values(allEids); } /** diff --git a/modules/userId/eids.md b/modules/userId/eids.md index 04073923ed1..c8d27cc9d52 100644 --- a/modules/userId/eids.md +++ b/modules/userId/eids.md @@ -77,6 +77,7 @@ userIdAsEids = [ uids: [{ id: 'the-ids-object-stringified', atype: 1 + }] }, { @@ -117,6 +118,50 @@ userIdAsEids = [ }] }, + { + source: 'liveintent.indexexchange.com', + uids: [{ + id: 'some-random-id-value', + atype: 3, + ext: { + provider: 'liveintent.com' + } + }] + }, + + { + source: 'liveintent.sovrn.com'', + uids: [{ + id: 'some-random-id-value', + atype: 3, + ext: { + provider: 'liveintent.com' + } + }] + }, + + { + source: 'openx.net'', + uids: [{ + id: 'some-random-id-value', + atype: 3, + ext: { + provider: 'liveintent.com' + } + }] + }, + + { + source: 'pubmatic.com'', + uids: [{ + id: 'some-random-id-value', + atype: 3, + ext: { + provider: 'liveintent.com' + } + }] + }, + { source: 'media.net', uids: [{ @@ -279,6 +324,13 @@ userIdAsEids = [ id: 'some-random-id-value', atype: 3 }] + }, + { + source: 'mygaru.com', + uids: [{ + id: 'some-random-id-value', + atype: 1 + }] } ] ``` diff --git a/modules/userId/index.js b/modules/userId/index.js index b20b38f0e40..5a088b27319 100644 --- a/modules/userId/index.js +++ b/modules/userId/index.js @@ -668,8 +668,8 @@ function encryptSignals(signals, version = 1) { } /** -* This function will be exposed in the global-name-space so that publisher can register the signals-ESP. -*/ + * This function will be exposed in the global-name-space so that publisher can register the signals-ESP. + */ function registerSignalSources() { if (!isGptPubadsDefined()) { return; @@ -886,14 +886,12 @@ function updateInitializedSubmodules(dest, submodule) { /** * list of submodule configurations with valid 'storage' or 'value' obj definitions - * * storage config: contains values for storing/retrieving User ID data in browser storage - * * value config: object properties that are copied to bids (without saving to storage) + * storage config: contains values for storing/retrieving User ID data in browser storage + * value config: object properties that are copied to bids (without saving to storage) * @param {SubmoduleConfig[]} configRegistry - * @param {Submodule[]} submoduleRegistry - * @param {string[]} activeStorageTypes * @returns {SubmoduleConfig[]} */ -function getValidSubmoduleConfigs(configRegistry, submoduleRegistry) { +function getValidSubmoduleConfigs(configRegistry) { if (!Array.isArray(configRegistry)) { return []; } @@ -958,7 +956,7 @@ function updateEIDConfig(submodules) { */ function updateSubmodules() { updateEIDConfig(submoduleRegistry); - const configs = getValidSubmoduleConfigs(configRegistry, submoduleRegistry); + const configs = getValidSubmoduleConfigs(configRegistry); if (!configs.length) { return; } diff --git a/modules/userId/userId.md b/modules/userId/userId.md index 01930a67dda..7a01e128814 100644 --- a/modules/userId/userId.md +++ b/modules/userId/userId.md @@ -158,6 +158,9 @@ pbjs.setConfig({ }, { name: "gravitompId" + }, + { + name: "mygaruId" } ], syncDelay: 5000, diff --git a/modules/vdoaiBidAdapter.js b/modules/vdoaiBidAdapter.js index fa1e2898a4a..05960378d23 100644 --- a/modules/vdoaiBidAdapter.js +++ b/modules/vdoaiBidAdapter.js @@ -1,6 +1,6 @@ -import {getAdUnitSizes} from '../src/utils.js'; import {registerBidder} from '../src/adapters/bidderFactory.js'; import {BANNER, VIDEO} from '../src/mediaTypes.js'; +import {getAdUnitSizes} from '../libraries/sizeUtils/sizeUtils.js'; const BIDDER_CODE = 'vdoai'; const ENDPOINT_URL = 'https://prebid.vdo.ai/auction'; diff --git a/modules/ventesBidAdapter.js b/modules/ventesBidAdapter.js index 73ae0a7e5f1..78c580c4116 100644 --- a/modules/ventesBidAdapter.js +++ b/modules/ventesBidAdapter.js @@ -1,8 +1,9 @@ import {BANNER, NATIVE, VIDEO} from '../src/mediaTypes.js'; -import {convertCamelToUnderscore, isArray, isNumber, isPlainObject, isStr, replaceAuctionPrice} from '../src/utils.js'; +import {isArray, isNumber, isPlainObject, isStr, replaceAuctionPrice} from '../src/utils.js'; import {find} from '../src/polyfill.js'; import {registerBidder} from '../src/adapters/bidderFactory.js'; import { convertOrtbRequestToProprietaryNative } from '../src/native.js'; +import {convertCamelToUnderscore} from '../libraries/appnexusUtils/anUtils.js'; const BID_METHOD = 'POST'; const BIDDER_URL = 'https://ad.ventesavenues.in/va/ad'; diff --git a/modules/viantOrtbBidAdapter.js b/modules/viantOrtbBidAdapter.js index e7bf9129a62..0f7953a192a 100644 --- a/modules/viantOrtbBidAdapter.js +++ b/modules/viantOrtbBidAdapter.js @@ -5,7 +5,7 @@ import {ortbConverter} from '../libraries/ortbConverter/converter.js' import {deepAccess, getBidIdParameter, logError} from '../src/utils.js'; const BIDDER_CODE = 'viant'; -const ENDPOINT = 'https://bidders-us-east-1.adelphic.net/d/rtb/v25/prebid/bidder_test' +const ENDPOINT = 'https://bidders-us-east-1.adelphic.net/d/rtb/v25/prebid/bidder' const DEFAULT_BID_TTL = 300; const DEFAULT_CURRENCY = 'USD'; diff --git a/modules/viantOrtbBidAdapter.md b/modules/viantOrtbBidAdapter.md index 178c2c18a0f..def93722b7b 100644 --- a/modules/viantOrtbBidAdapter.md +++ b/modules/viantOrtbBidAdapter.md @@ -2,7 +2,7 @@ Module Name: VIANT Bidder Adapter Module Type: Bidder Adapter -Maintainer: dist-runtime@viantinc.com +Maintainer: Marketplace@adelphic.com # Description diff --git a/modules/vidazooBidAdapter.js b/modules/vidazooBidAdapter.js index ba21a9c82d2..b5323181c6c 100644 --- a/modules/vidazooBidAdapter.js +++ b/modules/vidazooBidAdapter.js @@ -1,9 +1,10 @@ -import {_each, chunk, deepAccess, isFn, parseSizesInput, parseUrl, uniques, isArray} from '../src/utils.js'; +import {_each, deepAccess, isFn, parseSizesInput, parseUrl, uniques, isArray} from '../src/utils.js'; import {registerBidder} from '../src/adapters/bidderFactory.js'; import {BANNER, VIDEO} from '../src/mediaTypes.js'; import {getStorageManager} from '../src/storageManager.js'; import {bidderSettings} from '../src/bidderSettings.js'; import {config} from '../src/config.js'; +import {chunk} from '../libraries/chunk/chunk.js'; const GVLID = 744; const DEFAULT_SUB_DOMAIN = 'prebid'; diff --git a/modules/videoreachBidAdapter.js b/modules/videoreachBidAdapter.js index 9fd5853c75e..8835398d7cc 100644 --- a/modules/videoreachBidAdapter.js +++ b/modules/videoreachBidAdapter.js @@ -1,4 +1,4 @@ -import { getValue, getBidIdParameter } from '../src/utils.js'; +import {getBidIdParameter, getValue} from '../src/utils.js'; import {registerBidder} from '../src/adapters/bidderFactory.js'; const BIDDER_CODE = 'videoreach'; const ENDPOINT_URL = 'https://a.videoreach.com/hb/'; diff --git a/modules/visxBidAdapter.js b/modules/visxBidAdapter.js index c1bb626a39c..a86c958392e 100644 --- a/modules/visxBidAdapter.js +++ b/modules/visxBidAdapter.js @@ -1,9 +1,11 @@ -import { triggerPixel, parseSizesInput, deepAccess, logError, getGptSlotInfoForAdUnitCode } from '../src/utils.js'; -import { registerBidder } from '../src/adapters/bidderFactory.js'; -import { config } from '../src/config.js'; -import { BANNER, VIDEO } from '../src/mediaTypes.js'; -import { INSTREAM as VIDEO_INSTREAM } from '../src/video.js'; +import {deepAccess, logError, parseSizesInput, triggerPixel} from '../src/utils.js'; +import {registerBidder} from '../src/adapters/bidderFactory.js'; +import {config} from '../src/config.js'; +import {BANNER, VIDEO} from '../src/mediaTypes.js'; +import {INSTREAM as VIDEO_INSTREAM} from '../src/video.js'; import {getStorageManager} from '../src/storageManager.js'; +import {getGptSlotInfoForAdUnitCode} from '../libraries/gptUtils/gptUtils.js'; + const BIDDER_CODE = 'visx'; const GVLID = 154; const BASE_URL = 'https://t.visx.net'; @@ -13,6 +15,7 @@ const TIME_TO_LIVE = 360; const DEFAULT_CUR = 'EUR'; const ADAPTER_SYNC_PATH = '/push_sync'; const TRACK_TIMEOUT_PATH = '/track/bid_timeout'; +const RUNTIME_STATUS_RESPONSE_TIME = 999000; const LOG_ERROR_MESS = { noAuid: 'Bid from response has no auid parameter - ', noAdm: 'Bid from response has no adm parameter - ', @@ -31,6 +34,7 @@ const LOG_ERROR_MESS = { }; const currencyWhiteList = ['EUR', 'USD', 'GBP', 'PLN']; export const storage = getStorageManager({bidderCode: BIDDER_CODE}); +const _bidResponseTimeLogged = []; export const spec = { code: BIDDER_CODE, gvlid: GVLID, @@ -206,6 +210,12 @@ export const spec = { if (bid.ext && bid.ext.events && bid.ext.events.win) { triggerPixel(bid.ext.events.win); } + // Call 'track/runtime' with the corresponding bid.requestId - only once per auction + if (bid.ext && bid.ext.events && bid.ext.events.runtime && !_bidResponseTimeLogged.includes(bid.auctionId)) { + _bidResponseTimeLogged.push(bid.auctionId); + const _roundedTime = _roundResponseTime(bid.timeToRespond, 50); + triggerPixel(bid.ext.events.runtime.replace('{STATUS_CODE}', RUNTIME_STATUS_RESPONSE_TIME + _roundedTime)); + } }, onTimeout: function(timeoutData) { // Call '/track/bid_timeout' with timeout data @@ -319,6 +329,10 @@ function _addBidResponse(serverBid, bidsMap, currency, bidResponses) { if (serverBid.ext && serverBid.ext.prebid) { bidResponse.ext = serverBid.ext.prebid; + if (serverBid.ext.visx && serverBid.ext.visx.events) { + const prebidExtEvents = bidResponse.ext.events || {}; + bidResponse.ext.events = Object.assign(prebidExtEvents, serverBid.ext.visx.events); + } } const visxTargeting = deepAccess(serverBid, 'ext.prebid.targeting'); @@ -432,4 +446,15 @@ function _getUserId() { return null; } +function _roundResponseTime(time, timeRange) { + if (time <= 0) { + return 0; // Special code for scriptLoadTime of 0 ms or less + } else if (time > 5000) { + return 100; // Constant code for scriptLoadTime greater than 5000 ms + } else { + const roundedValue = Math.floor((time - 1) / timeRange) + 1; + return roundedValue; + } +} + registerBidder(spec); diff --git a/modules/voxBidAdapter.js b/modules/voxBidAdapter.js index 34bd46ccb98..431d0887334 100644 --- a/modules/voxBidAdapter.js +++ b/modules/voxBidAdapter.js @@ -12,6 +12,7 @@ const BIDDER_CODE = 'vox'; const SSP_ENDPOINT = 'https://ssp.hybrid.ai/auction/prebid'; const VIDEO_RENDERER_URL = 'https://acdn.adnxs.com/video/outstream/ANOutstreamVideo.js'; const TTL = 60; +const GVLID = 206; function buildBidRequests(validBidRequests) { return _map(validBidRequests, function(bid) { @@ -183,6 +184,7 @@ function wrapBanner(bid, bidData) { export const spec = { code: BIDDER_CODE, + gvlid: GVLID, supportedMediaTypes: [BANNER, VIDEO], /** diff --git a/modules/vrtcalBidAdapter.js b/modules/vrtcalBidAdapter.js index 21870e3218a..07dc35525c3 100644 --- a/modules/vrtcalBidAdapter.js +++ b/modules/vrtcalBidAdapter.js @@ -5,6 +5,8 @@ import { config } from '../src/config.js'; import {deepAccess, isFn, isPlainObject} from '../src/utils.js'; const GVLID = 706; +const VRTCAL_USER_SYNC_URL_IFRAME = `https://usync.vrtcal.com/i?ssp=1804&synctype=iframe`; +const VRTCAL_USER_SYNC_URL_REDIRECT = `https://usync.vrtcal.com/i?ssp=1804&synctype=redirect`; export const spec = { code: 'vrtcal', @@ -67,7 +69,7 @@ export const spec = { name: 'VRTCAL_FILLED', cat: deepAccess(bid, 'ortb2.site.cat', []), domain: decodeURIComponent(window.location.href).replace('https://', '').replace('http://', '').split('/')[0], - page: bid.refererInfo.page + page: window.location.href }, device: { language: navigator.language, @@ -148,7 +150,34 @@ export const spec = { ); ajax(winUrl, null); return true; + }, + + getUserSyncs: function(syncOptions, serverResponses, gdprConsent = {}, uspConsent = '', gppConsent = {}) { + const syncs = []; + const gdprFlag = `&gdpr=${gdprConsent.gdprApplies ? 1 : 0}`; + const gdprString = `&gdpr_consent=${encodeURIComponent((gdprConsent.consentString || ''))}`; + const usPrivacy = `&us_privacy=${encodeURIComponent(uspConsent)}`; + const gpp = gppConsent.gppString ? gppConsent.gppString : ''; + const gppSid = Array.isArray(gppConsent.applicableSections) ? gppConsent.applicableSections.join(',') : ''; + let vrtcalSyncURL = '' + + if (syncOptions.iframeEnabled) { + vrtcalSyncURL = `${VRTCAL_USER_SYNC_URL_IFRAME}${usPrivacy}${gdprFlag}${gdprString}&gpp=${gpp}&gpp_sid=${gppSid}&surl=`; + syncs.push({ + type: 'iframe', + url: vrtcalSyncURL + }); + } else { + vrtcalSyncURL = `${VRTCAL_USER_SYNC_URL_REDIRECT}${usPrivacy}${gdprFlag}${gdprString}&gpp=${gpp}&gpp_sid=${gppSid}&surl=`; + syncs.push({ + type: 'image', + url: vrtcalSyncURL + }); + } + + return syncs; } + }; registerBidder(spec); diff --git a/modules/weboramaRtdProvider.js b/modules/weboramaRtdProvider.js index 6ba502d2c8b..a0963b844e1 100644 --- a/modules/weboramaRtdProvider.js +++ b/modules/weboramaRtdProvider.js @@ -7,25 +7,29 @@ * @requires module:modules/realTimeData */ -/** profile metadata +/** + * profile metadata * @typedef dataCallbackMetadata * @property {boolean} user if true it is user-centric data * @property {string} source describe the source of data, if 'contextual' or 'wam' * @property {boolean} isDefault if true it the default profile defined in the configuration */ -/** profile from contextual, wam or sfbx +/** + * profile from contextual, wam or sfbx * @typedef {Object.
"
+ const mockServerResponse = {
+ body: [
+ {
+ requestId: '23a3d87fb6bde9',
+ cpm: 1.61,
+ currency: 'USD',
+ width: '336',
+ height: '280',
+ creativeId: '46271',
+ netRevenue: 'false',
+ ad: MOCK_AD_DOM,
+ meta: {
+ advertiserDomains: [''],
+ },
+ ttl: 360,
+ },
+ {
+ requestId: '3ce3efc40c890b',
+ cpm: 1.61,
+ currency: 'USD',
+ width: '336',
+ height: '280',
+ creativeId: '46271',
+ netRevenue: 'false',
+ ad: MOCK_AD_DOM,
+ meta: {
+ advertiserDomains: [''],
+ },
+ ttl: 360,
+ },
+ ],
+ };
+
+ const exceptServerResponse = [
+ {
+ requestId: '23a3d87fb6bde9',
+ cpm: 1.61,
+ currency: 'USD',
+ width: '336',
+ height: '280',
+ creativeId: '46271',
+ netRevenue: 'false',
+ ad: MOCK_AD_DOM,
+ meta: {
+ advertiserDomains: [''],
+ },
+ ttl: 360,
+ },
+ {
+ requestId: '3ce3efc40c890b',
+ cpm: 1.61,
+ currency: 'USD',
+ width: '336',
+ height: '280',
+ creativeId: '46271',
+ netRevenue: 'false',
+ ad: MOCK_AD_DOM,
+ meta: {
+ advertiserDomains: [''],
+ },
+ ttl: 360,
+ },
+ ]
+
+ const bidResponses = spec.interpretResponse(mockServerResponse);
+
+ expect(bidResponses).to.eql(exceptServerResponse);
+ });
+ });
+});
diff --git a/test/spec/modules/adagioAnalyticsAdapter_spec.js b/test/spec/modules/adagioAnalyticsAdapter_spec.js
index 581f3cb1b87..5ffd7b0b685 100644
--- a/test/spec/modules/adagioAnalyticsAdapter_spec.js
+++ b/test/spec/modules/adagioAnalyticsAdapter_spec.js
@@ -1,12 +1,14 @@
import adagioAnalyticsAdapter from 'modules/adagioAnalyticsAdapter.js';
import { expect } from 'chai';
import * as utils from 'src/utils.js';
+import { getGlobal } from 'src/prebidGlobal.js';
+import { server } from 'test/mocks/xhr.js';
let adapterManager = require('src/adapterManager').default;
let events = require('src/events');
let constants = require('src/constants.json');
-describe('adagio analytics adapter', () => {
+describe('adagio analytics adapter - adagio.js', () => {
let sandbox;
let adagioQueuePushSpy;
@@ -174,3 +176,658 @@ describe('adagio analytics adapter', () => {
});
});
});
+
+const AUCTION_ID = '25c6d7f5-699a-4bfc-87c9-996f915341fa';
+const AUCTION_ID_ADAGIO = '6fc53663-bde5-427b-ab63-baa9ed296f47'
+const AUCTION_ID_CACHE = 'b43d24a0-13d4-406d-8176-3181402bafc4';
+const AUCTION_ID_CACHE_ADAGIO = 'a9cae98f-efb5-477e-9259-27350044f8db';
+
+const BID_ADAGIO = Object.assign({}, BID_ADAGIO, {
+ bidder: 'adagio',
+ auctionId: AUCTION_ID,
+ adUnitCode: '/19968336/header-bid-tag-1',
+ bidId: '3bd4ebb1c900e2',
+ partnerImpId: 'partnerImpressionID-2',
+ adId: 'fake_ad_id_2',
+ requestId: '3bd4ebb1c900e2',
+ width: 728,
+ height: 90,
+ mediaType: 'banner',
+ cpm: 1.42,
+ currency: 'USD',
+ originalCpm: 1.42,
+ originalCurrency: 'USD',
+ dealId: 'the-deal-id',
+ dealChannel: 'PMP',
+ mi: 'matched-impression',
+ seatBidId: 'aaaa-bbbb-cccc-dddd',
+ adserverTargeting: {
+ 'hb_bidder': 'another',
+ 'hb_adid': '3bd4ebb1c900e2',
+ 'hb_pb': '1.500',
+ 'hb_size': '728x90',
+ 'hb_source': 'server'
+ },
+ meta: {
+ advertiserDomains: ['example.com']
+ },
+ pba: {
+ sid: '42',
+ e_pba_test: true
+ }
+});
+
+const BID_ANOTHER = Object.assign({}, BID_ANOTHER, {
+ bidder: 'another',
+ auctionId: AUCTION_ID,
+ adUnitCode: '/19968336/header-bid-tag-1',
+ bidId: '3bd4ebb1c900e2',
+ partnerImpId: 'partnerImpressionID-2',
+ adId: 'fake_ad_id_2',
+ requestId: '3bd4ebb1c900e2',
+ width: 728,
+ height: 90,
+ mediaType: 'banner',
+ cpm: 1.71,
+ currency: 'EUR',
+ originalCpm: 1.62,
+ originalCurrency: 'GBP',
+ dealId: 'the-deal-id',
+ dealChannel: 'PMP',
+ mi: 'matched-impression',
+ seatBidId: 'aaaa-bbbb-cccc-dddd',
+ adserverTargeting: {
+ 'hb_bidder': 'another',
+ 'hb_adid': '3bd4ebb1c900e2',
+ 'hb_pb': '1.500',
+ 'hb_size': '728x90',
+ 'hb_source': 'server'
+ },
+ meta: {
+ advertiserDomains: ['example.com']
+ }
+});
+
+const BID_CACHED = Object.assign({}, BID_ADAGIO, {
+ auctionId: AUCTION_ID_CACHE,
+ latestTargetedAuctionId: BID_ADAGIO.auctionId,
+});
+
+const PARAMS_ADG = {
+ organizationId: '1001',
+ site: 'test-com',
+ pageviewId: 'a68e6d70-213b-496c-be0a-c468ff387106',
+ environment: 'desktop',
+ pagetype: 'article',
+ placement: 'pave_top',
+ testName: 'test',
+ testVersion: 'version',
+};
+
+const AUCTION_INIT_ANOTHER = {
+ 'auctionId': AUCTION_ID,
+ 'timestamp': 1519767010567,
+ 'auctionStatus': 'inProgress',
+ 'adUnits': [ {
+ 'code': '/19968336/header-bid-tag-1',
+ 'mediaTypes': {
+ 'banner': {
+ 'sizes': [
+ [
+ 640,
+ 480
+ ],
+ [
+ 640,
+ 100
+ ]
+ ]
+ }
+ },
+ 'sizes': [[640, 480]],
+ 'bids': [ {
+ 'bidder': 'another',
+ 'params': {
+ 'publisherId': '1001'
+ },
+ }, {
+ 'bidder': 'nobid',
+ 'params': {
+ 'publisherId': '1002'
+ },
+ }, {
+ 'bidder': 'adagio',
+ 'params': {
+ ...PARAMS_ADG
+ },
+ }, ],
+ 'transactionId': 'ca4af27a-6d02-4f90-949d-d5541fa12014'
+ }, {
+ 'code': '/19968336/footer-bid-tag-1',
+ 'mediaTypes': {
+ 'banner': {
+ 'sizes': [
+ [
+ 640,
+ 480
+ ]
+ ]
+ }
+ },
+ 'sizes': [[640, 480]],
+ 'bids': [ {
+ 'bidder': 'another',
+ 'params': {
+ 'publisherId': '1001'
+ },
+ } ],
+ 'transactionId': 'ca4af27a-6d02-4f90-949d-d5541fa12014'
+ } ],
+ 'adUnitCodes': ['/19968336/header-bid-tag-1', '/19968336/footer-bid-tag-1'],
+ 'bidderRequests': [ {
+ 'bidderCode': 'another',
+ 'auctionId': AUCTION_ID,
+ 'bidderRequestId': '1be65d7958826a',
+ 'bids': [ {
+ 'bidder': 'another',
+ 'params': {
+ 'publisherId': '1001',
+ },
+ 'mediaTypes': {
+ 'banner': {
+ 'sizes': [[640, 480]]
+ }
+ },
+ 'adUnitCode': '/19968336/header-bid-tag-1',
+ 'transactionId': 'ca4af27a-6d02-4f90-949d-d5541fa12014',
+ 'sizes': [[640, 480]],
+ 'bidId': '2ecff0db240757',
+ 'bidderRequestId': '1be65d7958826a',
+ 'auctionId': AUCTION_ID,
+ 'src': 'client',
+ 'bidRequestsCount': 1
+ }, {
+ 'bidder': 'another',
+ 'params': {
+ 'publisherId': '1001'
+ },
+ 'mediaTypes': {
+ 'banner': {
+ 'sizes': [[640, 480]]
+ }
+ },
+ 'adUnitCode': '/19968336/footer-bid-tag-1',
+ 'transactionId': 'ca4af27a-6d02-4f90-949d-d5541fa12014',
+ 'sizes': [[640, 480]],
+ 'bidId': '2ecff0db240757',
+ 'bidderRequestId': '1be65d7958826a',
+ 'auctionId': AUCTION_ID,
+ 'src': 'client',
+ 'bidRequestsCount': 1
+ }, {
+ 'bidder': 'nobid',
+ 'params': {
+ 'publisherId': '1001'
+ },
+ 'mediaTypes': {
+ 'banner': {
+ 'sizes': [[640, 480]]
+ }
+ },
+ 'adUnitCode': '/19968336/footer-bid-tag-1',
+ 'transactionId': 'ca4af27a-6d02-4f90-949d-d5541fa12014',
+ 'sizes': [[640, 480]],
+ 'bidId': '2ecff0db240757',
+ 'bidderRequestId': '1be65d7958826a',
+ 'auctionId': AUCTION_ID,
+ 'src': 'client',
+ 'bidRequestsCount': 1
+ }
+ ],
+ 'timeout': 3000,
+ 'refererInfo': {
+ 'topmostLocation': 'http://www.test.com/page.html', 'reachedTop': true, 'numIframes': 0, 'stack': ['http://www.test.com/page.html']
+ }
+ }, {
+ 'bidderCode': 'adagio',
+ 'auctionId': AUCTION_ID,
+ 'bidderRequestId': '1be65d7958826a',
+ 'bids': [ {
+ 'bidder': 'adagio',
+ 'params': {
+ ...PARAMS_ADG,
+ adagioAuctionId: AUCTION_ID_ADAGIO
+ },
+ 'mediaTypes': {
+ 'banner': {
+ 'sizes': [[640, 480]]
+ }
+ },
+ 'adUnitCode': '/19968336/header-bid-tag-1',
+ 'transactionId': 'ca4af27a-6d02-4f90-949d-d5541fa12014',
+ 'sizes': [[640, 480]],
+ 'bidId': '2ecff0db240757',
+ 'bidderRequestId': '1be65d7958826a',
+ 'auctionId': AUCTION_ID,
+ 'src': 'client',
+ 'bidRequestsCount': 1
+ }
+ ],
+ 'timeout': 3000,
+ 'refererInfo': {
+ 'topmostLocation': 'http://www.test.com/page.html', 'reachedTop': true, 'numIframes': 0, 'stack': ['http://www.test.com/page.html']
+ }
+ }
+ ],
+ 'bidsReceived': [],
+ 'winningBids': [],
+ 'timeout': 3000
+};
+
+const AUCTION_INIT_CACHE = {
+ 'auctionId': AUCTION_ID_CACHE,
+ 'timestamp': 1519767010567,
+ 'auctionStatus': 'inProgress',
+ 'adUnits': [ {
+ 'code': '/19968336/header-bid-tag-1',
+ 'mediaTypes': {
+ 'banner': {
+ 'sizes': [
+ [
+ 640,
+ 480
+ ],
+ [
+ 640,
+ 100
+ ]
+ ]
+ }
+ },
+ 'sizes': [[640, 480]],
+ 'bids': [ {
+ 'bidder': 'another',
+ 'params': {
+ 'publisherId': '1001'
+ },
+ }, {
+ 'bidder': 'adagio',
+ 'params': {
+ ...PARAMS_ADG
+ },
+ }, ],
+ 'transactionId': 'ca4af27a-6d02-4f90-949d-d5541fa12014'
+ }, {
+ 'code': '/19968336/footer-bid-tag-1',
+ 'mediaTypes': {
+ 'banner': {
+ 'sizes': [
+ [
+ 640,
+ 480
+ ]
+ ]
+ }
+ },
+ 'sizes': [[640, 480]],
+ 'bids': [ {
+ 'bidder': 'another',
+ 'params': {
+ 'publisherId': '1001'
+ },
+ } ],
+ 'transactionId': 'ca4af27a-6d02-4f90-949d-d5541fa12014'
+ } ],
+ 'adUnitCodes': ['/19968336/header-bid-tag-1', '/19968336/footer-bid-tag-1'],
+ 'bidderRequests': [ {
+ 'bidderCode': 'another',
+ 'auctionId': AUCTION_ID_CACHE,
+ 'bidderRequestId': '1be65d7958826a',
+ 'bids': [ {
+ 'bidder': 'another',
+ 'params': {
+ 'publisherId': '1001',
+ },
+ 'mediaTypes': {
+ 'banner': {
+ 'sizes': [[640, 480]]
+ }
+ },
+ 'adUnitCode': '/19968336/header-bid-tag-1',
+ 'transactionId': 'ca4af27a-6d02-4f90-949d-d5541fa12014',
+ 'sizes': [[640, 480]],
+ 'bidId': '2ecff0db240757',
+ 'bidderRequestId': '1be65d7958826a',
+ 'auctionId': AUCTION_ID_CACHE,
+ 'src': 'client',
+ 'bidRequestsCount': 1
+ }, {
+ 'bidder': 'another',
+ 'params': {
+ 'publisherId': '1001'
+ },
+ 'mediaTypes': {
+ 'banner': {
+ 'sizes': [[640, 480]]
+ }
+ },
+ 'adUnitCode': '/19968336/footer-bid-tag-1',
+ 'transactionId': 'ca4af27a-6d02-4f90-949d-d5541fa12014',
+ 'sizes': [[640, 480]],
+ 'bidId': '2ecff0db240757',
+ 'bidderRequestId': '1be65d7958826a',
+ 'auctionId': AUCTION_ID_CACHE,
+ 'src': 'client',
+ 'bidRequestsCount': 1
+ }
+ ],
+ 'timeout': 3000,
+ 'refererInfo': {
+ 'topmostLocation': 'http://www.test.com/page.html', 'reachedTop': true, 'numIframes': 0, 'stack': ['http://www.test.com/page.html']
+ }
+ }, {
+ 'bidderCode': 'adagio',
+ 'auctionId': AUCTION_ID_CACHE,
+ 'bidderRequestId': '1be65d7958826a',
+ 'bids': [ {
+ 'bidder': 'adagio',
+ 'params': {
+ ...PARAMS_ADG,
+ adagioAuctionId: AUCTION_ID_CACHE_ADAGIO
+ },
+ 'mediaTypes': {
+ 'banner': {
+ 'sizes': [[640, 480]]
+ }
+ },
+ 'adUnitCode': '/19968336/header-bid-tag-1',
+ 'transactionId': 'ca4af27a-6d02-4f90-949d-d5541fa12014',
+ 'sizes': [[640, 480]],
+ 'bidId': '2ecff0db240757',
+ 'bidderRequestId': '1be65d7958826a',
+ 'auctionId': AUCTION_ID_CACHE,
+ 'src': 'client',
+ 'bidRequestsCount': 1
+ }
+ ],
+ 'timeout': 3000,
+ 'refererInfo': {
+ 'topmostLocation': 'http://www.test.com/page.html', 'reachedTop': true, 'numIframes': 0, 'stack': ['http://www.test.com/page.html']
+ }
+ }
+ ],
+ 'bidsReceived': [],
+ 'winningBids': [],
+ 'timeout': 3000
+};
+
+const AUCTION_END_ANOTHER = Object.assign({}, AUCTION_INIT_ANOTHER, {
+ bidsReceived: [BID_ANOTHER, BID_ADAGIO]
+});
+
+const AUCTION_END_ANOTHER_NOBID = Object.assign({}, AUCTION_INIT_ANOTHER, {
+ bidsReceived: []
+});
+
+const MOCK = {
+ SET_TARGETING: {
+ [BID_ADAGIO.adUnitCode]: BID_ADAGIO.adserverTargeting,
+ [BID_ANOTHER.adUnitCode]: BID_ANOTHER.adserverTargeting
+ },
+ AUCTION_INIT: {
+ another: AUCTION_INIT_ANOTHER,
+ bidcached: AUCTION_INIT_CACHE
+ },
+ BID_RESPONSE: {
+ adagio: BID_ADAGIO,
+ another: BID_ANOTHER
+ },
+ AUCTION_END: {
+ another: AUCTION_END_ANOTHER,
+ another_nobid: AUCTION_END_ANOTHER_NOBID
+ },
+ BID_WON: {
+ adagio: Object.assign({}, BID_ADAGIO, {
+ 'status': 'rendered'
+ }),
+ another: Object.assign({}, BID_ANOTHER, {
+ 'status': 'rendered'
+ }),
+ bidcached: Object.assign({}, BID_CACHED, {
+ 'status': 'rendered'
+ }),
+ },
+ AD_RENDER_SUCCEEDED: {
+ another: {
+ ad: '', ext: {crType: 'banner'}}]
- }]
- }
- };
- let bidRequest = {
- data: {},
- bids: [
- {
- bidId: 'bidId1',
- params: {adzoneid: 1000}
- }
- ]
- };
-
- bids = spec.interpretResponse(serverResponse, bidRequest);
- assert.equal(bids.length, 1);
- assert.equal(bids[0].ad, '');
- assert.equal(bids[0].mediaType, 'banner');
- assert.equal(bids[0].meta.mediaType, 'banner');
- });
- });
-
- describe('video', function () {
- it('should set vastXml on response', function () {
- let serverResponse = {
- body: {
- seatbid: [{
- bid: [{impid: '1', adm: '', ext: {crType: 'video'}}]
- }]
- }
- };
- let bidRequest = {
- data: {},
- bids: [
- {
- bidId: 'bidId1',
- params: {adzoneid: 1000}
- }
- ]
- };
-
- bids = spec.interpretResponse(serverResponse, bidRequest);
- assert.equal(bids.length, 1);
- assert.equal(bids[0].vastXml, '');
- assert.equal(bids[0].mediaType, 'video');
- assert.equal(bids[0].meta.mediaType, 'video');
- });
- });
- });
-
describe('getUserSyncs', function () {
const usersyncUrl = 'https://usersync-url.com';
beforeEach(() => {
@@ -846,55 +30,55 @@ describe('Adxcg adapter', function () {
})
it('should return user sync if pixel enabled with adxcg config', function () {
- const ret = spec.getUserSyncs({pixelEnabled: true})
- expect(ret).to.deep.equal([{type: 'image', url: usersyncUrl}])
+ const ret = spec.getUserSyncs({ pixelEnabled: true })
+ expect(ret).to.deep.equal([{ type: 'image', url: usersyncUrl }])
})
it('should not return user sync if pixel disabled', function () {
- const ret = spec.getUserSyncs({pixelEnabled: false})
+ const ret = spec.getUserSyncs({ pixelEnabled: false })
expect(ret).to.be.an('array').that.is.empty
})
it('should not return user sync if url is not set', function () {
config.resetConfig()
- const ret = spec.getUserSyncs({pixelEnabled: true})
+ const ret = spec.getUserSyncs({ pixelEnabled: true })
expect(ret).to.be.an('array').that.is.empty
})
- it('should pass GDPR consent', function() {
- expect(spec.getUserSyncs({ pixelEnabled: true }, {}, {gdprApplies: true, consentString: 'foo'}, undefined)).to.deep.equal([{
+ it('should pass GDPR consent', function () {
+ expect(spec.getUserSyncs({ pixelEnabled: true }, {}, { gdprApplies: true, consentString: 'foo' }, undefined)).to.deep.equal([{
type: 'image', url: `${usersyncUrl}?gdpr=1&gdpr_consent=foo`
}]);
- expect(spec.getUserSyncs({ pixelEnabled: true }, {}, {gdprApplies: false, consentString: 'foo'}, undefined)).to.deep.equal([{
+ expect(spec.getUserSyncs({ pixelEnabled: true }, {}, { gdprApplies: false, consentString: 'foo' }, undefined)).to.deep.equal([{
type: 'image', url: `${usersyncUrl}?gdpr=0&gdpr_consent=foo`
}]);
- expect(spec.getUserSyncs({ pixelEnabled: true }, {}, {gdprApplies: true, consentString: undefined}, undefined)).to.deep.equal([{
+ expect(spec.getUserSyncs({ pixelEnabled: true }, {}, { gdprApplies: true, consentString: undefined }, undefined)).to.deep.equal([{
type: 'image', url: `${usersyncUrl}?gdpr=1&gdpr_consent=`
}]);
});
- it('should pass US consent', function() {
+ it('should pass US consent', function () {
expect(spec.getUserSyncs({ pixelEnabled: true }, {}, undefined, '1NYN')).to.deep.equal([{
type: 'image', url: `${usersyncUrl}?us_privacy=1NYN`
}]);
});
- it('should pass GDPR and US consent', function() {
- expect(spec.getUserSyncs({ pixelEnabled: true }, {}, {gdprApplies: true, consentString: 'foo'}, '1NYN')).to.deep.equal([{
+ it('should pass GDPR and US consent', function () {
+ expect(spec.getUserSyncs({ pixelEnabled: true }, {}, { gdprApplies: true, consentString: 'foo' }, '1NYN')).to.deep.equal([{
type: 'image', url: `${usersyncUrl}?gdpr=1&gdpr_consent=foo&us_privacy=1NYN`
}]);
});
});
- describe('onBidWon', function() {
- beforeEach(function() {
+ describe('onBidWon', function () {
+ beforeEach(function () {
sinon.stub(utils, 'triggerPixel');
});
- afterEach(function() {
+ afterEach(function () {
utils.triggerPixel.restore();
});
- it('Should trigger pixel if bid nurl', function() {
+ it('Should trigger pixel if bid nurl', function () {
const bid = {
nurl: 'http://example.com/win/${AUCTION_PRICE}',
cpm: 2.1,
@@ -904,4 +88,510 @@ describe('Adxcg adapter', function () {
expect(utils.triggerPixel.callCount).to.equal(1)
})
})
+
+ it('should return just to have at least 1 karma test ok', function () {
+ assert(true);
+ });
+});
+
+describe('adxcg v8 oRtbConverter Adapter Tests', function () {
+ const slotConfigs = [{
+ placementCode: '/DfpAccount1/slot1',
+ mediaTypes: {
+ banner: {
+ sizes: [[728, 90], [160, 600]]
+ }
+ },
+ bidId: 'bid12345',
+ params: {
+ cp: 'p10000',
+ ct: 't10000',
+ cf: '300x250',
+ adzoneid: '77'
+ }
+ }, {
+ placementCode: '/DfpAccount2/slot2',
+ mediaTypes: {
+ banner: {
+ sizes: [[728, 90]]
+ }
+ },
+ bidId: 'bid23456',
+ params: {
+ cp: 'p10000',
+ ct: 't20000',
+ cf: '728x90',
+ adzoneid: '77'
+ }
+ }];
+ const nativeOrtbRequest = {
+ assets: [{
+ id: 1,
+ required: 1,
+ img: {
+ type: 3,
+ w: 150,
+ h: 50,
+ }
+ },
+ {
+ id: 2,
+ required: 1,
+ title: {
+ len: 80
+ }
+ },
+ {
+ id: 3,
+ required: 0,
+ data: {
+ type: 1
+ }
+ }]
+ };
+ const nativeSlotConfig = [{
+ placementCode: '/DfpAccount1/slot3',
+ bidId: 'bid12345',
+ mediaTypes: {
+ native: {
+ sendTargetingKeys: false,
+ ortb: nativeOrtbRequest
+ }
+ },
+ nativeOrtbRequest,
+ params: {
+ cp: 'p10000',
+ ct: 't10000',
+ adzoneid: '77'
+ }
+ }];
+ const videoSlotConfig = [{
+ placementCode: '/DfpAccount1/slotVideo',
+ bidId: 'bid12345',
+ mediaTypes: {
+ video: {
+ playerSize: [400, 300],
+ w: 400,
+ h: 300,
+ minduration: 5,
+ maxduration: 10,
+ startdelay: 0,
+ skip: 1,
+ minbitrate: 200,
+ protocols: [1, 2, 4]
+ }
+ },
+ params: {
+ cp: 'p10000',
+ ct: 't10000',
+ adzoneid: '77'
+ }
+ }];
+ const additionalParamsConfig = [{
+ placementCode: '/DfpAccount1/slot1',
+ mediaTypes: {
+ banner: {
+ sizes: [[1, 1]]
+ }
+ },
+ bidId: 'bid12345',
+ params: {
+ cp: 'p10000',
+ ct: 't10000',
+ cf: '1x1',
+ adzoneid: '77',
+ extra_key1: 'extra_val1',
+ extra_key2: 12345,
+ extra_key3: {
+ key1: 'val1',
+ key2: 23456,
+ },
+ extra_key4: [1, 2, 3]
+ }
+ }];
+
+ const schainParamsSlotConfig = [{
+ placementCode: '/DfpAccount1/slot1',
+ mediaTypes: {
+ banner: {
+ sizes: [[1, 1]]
+ }
+ },
+ bidId: 'bid12345',
+ params: {
+ cp: 'p10000',
+ ct: 't10000',
+ cf: '1x1',
+ adzoneid: '77',
+ bcat: ['IAB-1', 'IAB-20'],
+ battr: [1, 2, 3],
+ bidfloor: 1.5,
+ badv: ['cocacola.com', 'lays.com']
+ },
+ schain: {
+ 'ver': '1.0',
+ 'complete': 1,
+ 'nodes': [
+ {
+ 'asi': 'exchange1.com',
+ 'sid': '1234',
+ 'hp': 1,
+ 'rid': 'bid-request-1',
+ 'name': 'publisher',
+ 'domain': 'publisher.com'
+ }
+ ]
+ },
+ }];
+
+ const bidderRequest = {
+ refererInfo: {
+ page: 'https://publisher.com/home',
+ ref: 'https://referrer'
+ }
+ };
+
+ it('Verify build request', function () {
+ const request = spec.buildRequests(slotConfigs, syncAddFPDToBidderRequest(bidderRequest));
+ expect(request.url).to.equal('https://pbc.adxcg.net/rtb/ortb/pbc?adExchangeId=1');
+ expect(request.method).to.equal('POST');
+ const ortbRequest = request.data;
+ // site object
+ expect(ortbRequest.site).to.not.equal(null);
+ expect(ortbRequest.site.publisher).to.not.equal(null);
+ // expect(ortbRequest.site.publisher.id).to.equal('p10000');
+ expect(ortbRequest.site.page).to.equal('https://publisher.com/home');
+ expect(ortbRequest.imp).to.have.lengthOf(2);
+ // device object
+ expect(ortbRequest.device).to.not.equal(null);
+ expect(ortbRequest.device.ua).to.equal(navigator.userAgent);
+ // slot 1
+ // expect(ortbRequest.imp[0].tagid).to.equal('t10000');
+ expect(ortbRequest.imp[0].banner).to.not.equal(null);
+ expect(ortbRequest.imp[0].banner.format).to.deep.eq([{ 'w': 728, 'h': 90 }, { 'w': 160, 'h': 600 }]);
+ // slot 2
+ // expect(ortbRequest.imp[1].tagid).to.equal('t20000');
+ expect(ortbRequest.imp[1].banner).to.not.equal(null);
+ expect(ortbRequest.imp[1].banner.format).to.deep.eq([{ 'w': 728, 'h': 90 }]);
+ });
+
+ it('Verify parse response', function () {
+ const request = spec.buildRequests(slotConfigs, syncAddFPDToBidderRequest(bidderRequest));
+ const ortbRequest = request.data;
+ const ortbResponse = {
+ seatbid: [{
+ bid: [{
+ impid: ortbRequest.imp[0].id,
+ price: 1.25,
+ adm: 'This is an Ad',
+ crid: 'Creative#123',
+ mtype: 1,
+ w: 300,
+ h: 250,
+ exp: 20,
+ adomain: ['advertiser.com']
+ }]
+ }]
+ };
+ const bids = spec.interpretResponse({ body: ortbResponse }, request);
+ expect(bids).to.have.lengthOf(1);
+ // verify first bid
+ const bid = bids[0];
+ expect(bid.cpm).to.equal(1.25);
+ expect(bid.ad).to.equal('This is an Ad');
+ expect(bid.width).to.equal(300);
+ expect(bid.height).to.equal(250);
+ expect(bid.creative_id).to.equal('Creative#123');
+ expect(bid.creativeId).to.equal('Creative#123');
+ expect(bid.netRevenue).to.equal(true);
+ expect(bid.currency).to.equal('EUR');
+ expect(bid.ttl).to.equal(20);
+ expect(bid.meta).to.not.be.null;
+ expect(bid.meta.advertiserDomains).to.eql(['advertiser.com']);
+ });
+
+ it('Verify full passback', function () {
+ const request = spec.buildRequests(slotConfigs, bidderRequest);
+ const bids = spec.interpretResponse({ body: null }, request)
+ expect(bids).to.have.lengthOf(0);
+ });
+
+ if (FEATURES.NATIVE) {
+ it('Verify Native request', function () {
+ const request = spec.buildRequests(nativeSlotConfig, syncAddFPDToBidderRequest(bidderRequest));
+ expect(request.url).to.equal('https://pbc.adxcg.net/rtb/ortb/pbc?adExchangeId=1');
+ expect(request.method).to.equal('POST');
+ const ortbRequest = request.data;
+ // native impression
+ expect(ortbRequest.imp[0].tagid).to.equal('77');
+ expect(ortbRequest.imp[0].banner).to.be.undefined;
+ const nativePart = ortbRequest.imp[0]['native'];
+ expect(nativePart).to.not.equal(null);
+ expect(nativePart.request).to.not.equal(null);
+ // native request assets
+ const nativeRequest = JSON.parse(ortbRequest.imp[0]['native'].request);
+ expect(nativeRequest).to.not.equal(null);
+ expect(nativeRequest.assets).to.have.lengthOf(3);
+ // image asset
+ expect(nativeRequest.assets[0].id).to.equal(1);
+ expect(nativeRequest.assets[0].required).to.equal(1);
+ expect(nativeRequest.assets[0].title).to.be.undefined;
+ expect(nativeRequest.assets[0].img).to.not.equal(null);
+ expect(nativeRequest.assets[0].img.w).to.equal(150);
+ expect(nativeRequest.assets[0].img.h).to.equal(50);
+ expect(nativeRequest.assets[0].img.type).to.equal(3);
+ // title asset
+ expect(nativeRequest.assets[1].id).to.equal(2);
+ expect(nativeRequest.assets[1].required).to.equal(1);
+ expect(nativeRequest.assets[1].title).to.not.equal(null);
+ expect(nativeRequest.assets[1].title.len).to.equal(80);
+ // data asset
+ expect(nativeRequest.assets[2].id).to.equal(3);
+ expect(nativeRequest.assets[2].required).to.equal(0);
+ expect(nativeRequest.assets[2].title).to.be.undefined;
+ expect(nativeRequest.assets[2].data).to.not.equal(null);
+ expect(nativeRequest.assets[2].data.type).to.equal(1);
+ });
+
+ it('Verify Native response', function () {
+ const request = spec.buildRequests(nativeSlotConfig, syncAddFPDToBidderRequest(bidderRequest));
+ expect(request.url).to.equal('https://pbc.adxcg.net/rtb/ortb/pbc?adExchangeId=1');
+ expect(request.method).to.equal('POST');
+ const ortbRequest = request.data;
+ const nativeResponse = {
+ assets: [
+ { id: 1, img: { type: 3, url: 'https://images.cdn.brand.com/123' } },
+ { id: 2, title: { text: 'Ad Title' } },
+ { id: 3, data: { type: 1, value: 'Sponsored By: Brand' } }
+ ],
+ link: { url: 'https://brand.clickme.com/' },
+ imptrackers: ['https://imp1.trackme.com/', 'https://imp1.contextweb.com/']
+
+ };
+ const ortbResponse = {
+ seatbid: [{
+ bid: [{
+ impid: ortbRequest.imp[0].id,
+ price: 1.25,
+ adm: JSON.stringify(nativeResponse),
+ mtype: 4
+ }]
+ }]
+ };
+ const bids = spec.interpretResponse({ body: ortbResponse }, request);
+ // verify bid
+ const bid = bids[0];
+ expect(bid.cpm).to.equal(1.25);
+ expect(bid.requestId).to.equal('bid12345');
+ expect(bid.ad).to.be.undefined;
+ expect(bid.mediaType).to.equal('native');
+ expect(bid['native']).to.not.be.null;
+ expect(bid['native'].ortb).to.not.be.null;
+ const nativeBid = bid['native'].ortb;
+ expect(nativeBid.assets).to.have.lengthOf(3);
+ expect(nativeBid.assets[0].id).to.equal(1);
+ expect(nativeBid.assets[0].img).to.not.be.null;
+ expect(nativeBid.assets[0].img.type).to.equal(3);
+ expect(nativeBid.assets[0].img.url).to.equal('https://images.cdn.brand.com/123');
+ expect(nativeBid.assets[1].id).to.equal(2);
+ expect(nativeBid.assets[1].title).to.not.be.null;
+ expect(nativeBid.assets[1].title.text).to.equal('Ad Title');
+ expect(nativeBid.assets[2].id).to.equal(3);
+ expect(nativeBid.assets[2].data).to.not.be.null;
+ expect(nativeBid.assets[2].data.type).to.equal(1);
+ expect(nativeBid.assets[2].data.value).to.equal('Sponsored By: Brand');
+ expect(nativeBid.link).to.not.be.null;
+ expect(nativeBid.link.url).to.equal('https://brand.clickme.com/');
+ expect(nativeBid.imptrackers).to.have.lengthOf(2);
+ expect(nativeBid.imptrackers[0]).to.equal('https://imp1.trackme.com/');
+ expect(nativeBid.imptrackers[1]).to.equal('https://imp1.contextweb.com/');
+ });
+ }
+
+ it('Verifies bidder code', function () {
+ expect(spec.code).to.equal('adxcg');
+ });
+
+ it('Verifies bidder aliases', function () {
+ expect(spec.aliases).to.have.lengthOf(1);
+ expect(spec.aliases[0]).to.equal('mediaopti');
+ });
+
+ it('Verifies supported media types', function () {
+ expect(spec.supportedMediaTypes).to.have.lengthOf(3);
+ expect(spec.supportedMediaTypes[0]).to.equal('banner');
+ expect(spec.supportedMediaTypes[1]).to.equal('native');
+ expect(spec.supportedMediaTypes[2]).to.equal('video');
+ });
+
+ if (FEATURES.VIDEO) {
+ it('Verify Video request', function () {
+ const request = spec.buildRequests(videoSlotConfig, syncAddFPDToBidderRequest(bidderRequest));
+ expect(request.url).to.equal('https://pbc.adxcg.net/rtb/ortb/pbc?adExchangeId=1');
+ expect(request.method).to.equal('POST');
+ const ortbRequest = request.data;
+ expect(ortbRequest).to.not.equal(null);
+ expect(ortbRequest.imp).to.have.lengthOf(1);
+ expect(ortbRequest.imp[0].video).to.not.be.null;
+ expect(ortbRequest.imp[0].native).to.be.undefined;
+ expect(ortbRequest.imp[0].banner).to.be.undefined;
+ expect(ortbRequest.imp[0].video.w).to.equal(400);
+ expect(ortbRequest.imp[0].video.h).to.equal(300);
+ expect(ortbRequest.imp[0].video.minduration).to.equal(5);
+ expect(ortbRequest.imp[0].video.maxduration).to.equal(10);
+ expect(ortbRequest.imp[0].video.startdelay).to.equal(0);
+ expect(ortbRequest.imp[0].video.skip).to.equal(1);
+ expect(ortbRequest.imp[0].video.minbitrate).to.equal(200);
+ expect(ortbRequest.imp[0].video.protocols).to.eql([1, 2, 4]);
+ });
+ }
+
+ it('Verify extra parameters', function () {
+ let request = spec.buildRequests(additionalParamsConfig, syncAddFPDToBidderRequest(bidderRequest));
+ let ortbRequest = request.data;
+ expect(ortbRequest).to.not.equal(null);
+ expect(ortbRequest.imp).to.have.lengthOf(1);
+ expect(ortbRequest.imp[0].ext).to.not.equal(null);
+ expect(ortbRequest.imp[0].ext.prebid).to.not.equal(null);
+ expect(ortbRequest.imp[0].ext.prebid).to.not.be.null;
+ expect(ortbRequest.imp[0].ext.prebid.extra_key1).to.equal('extra_val1');
+ expect(ortbRequest.imp[0].ext.prebid.extra_key2).to.equal(12345);
+ expect(ortbRequest.imp[0].ext.prebid.extra_key3).to.not.be.null;
+ expect(ortbRequest.imp[0].ext.prebid.extra_key3.key1).to.equal('val1');
+ expect(ortbRequest.imp[0].ext.prebid.extra_key3.key2).to.equal(23456);
+ expect(ortbRequest.imp[0].ext.prebid.extra_key4).to.eql([1, 2, 3]);
+ expect(Object.keys(ortbRequest.imp[0].ext.prebid)).to.eql(['adzoneid', 'extra_key1', 'extra_key2', 'extra_key3', 'extra_key4']);
+ // attempting with a configuration with no unknown params.
+ request = spec.buildRequests(videoSlotConfig, bidderRequest);
+ ortbRequest = request.data;
+ expect(ortbRequest).to.not.equal(null);
+ expect(ortbRequest.imp).to.have.lengthOf(1);
+ // expect(ortbRequest.imp[0].ext).to.be.undefined;
+ });
+
+ it('Verify user level first party data', function () {
+ const bidderRequest = {
+ refererInfo: {
+ page: 'https://publisher.com/home',
+ ref: 'https://referrer'
+ },
+ gdprConsent: {
+ gdprApplies: true,
+ consentString: 'serialized_gpdr_data'
+ },
+ ortb2: {
+ user: {
+ yob: 1985,
+ gender: 'm',
+ ext: {
+ data: {
+ registered: true,
+ interests: ['cars']
+ }
+ }
+ }
+ }
+ };
+ let request = spec.buildRequests(slotConfigs, syncAddFPDToBidderRequest(bidderRequest));
+ let ortbRequest = request.data;
+ expect(ortbRequest).to.not.equal(null);
+ expect(ortbRequest.user).to.not.equal(null);
+ });
+
+ it('Verify site level first party data', function () {
+ const bidderRequest = {
+ ortb2: {
+ site: {
+ content: {
+ data: [{
+ name: 'www.iris.com',
+ ext: {
+ segtax: 500,
+ cids: ['iris_c73g5jq96mwso4d8']
+ }
+ }]
+ },
+ page: 'http://pub.com/news',
+ ref: 'http://google.com',
+ publisher: {
+ domain: 'pub.com'
+ }
+ }
+ }
+ };
+ let request = spec.buildRequests(slotConfigs, syncAddFPDToBidderRequest(bidderRequest));
+ let ortbRequest = request.data;
+ expect(ortbRequest).to.not.equal(null);
+ expect(ortbRequest.site).to.not.equal(null);
+ expect(ortbRequest.site).to.deep.equal({
+ content: {
+ data: [{
+ name: 'www.iris.com',
+ ext: {
+ segtax: 500,
+ cids: ['iris_c73g5jq96mwso4d8']
+ }
+ }]
+ },
+ page: 'http://pub.com/news',
+ ref: 'http://google.com',
+ publisher: {
+ // id: 'p10000',
+ domain: 'pub.com'
+ }
+ });
+ });
+
+ it('Verify impression/slot level first party data', function () {
+ const bidderRequests = [{
+ placementCode: '/DfpAccount1/slot1',
+ mediaTypes: {
+ banner: {
+ sizes: [[1, 1]]
+ }
+ },
+ bidId: 'bid12345',
+ params: {
+ cp: 'p10000',
+ ct: 't10000',
+ adzoneid: '77',
+ extra_key1: 'extra_val1',
+ extra_key2: 12345
+ },
+ ortb2Imp: {
+ ext: {
+ data: {
+ pbadslot: 'homepage-top-rect',
+ adUnitSpecificAttribute: '123'
+ }
+ }
+ }
+ }];
+ let request = spec.buildRequests(bidderRequests, bidderRequest);
+ let ortbRequest = request.data;
+ expect(ortbRequest).to.not.equal(null);
+ expect(ortbRequest.imp).to.not.equal(null);
+ expect(ortbRequest.imp).to.have.lengthOf(1);
+ expect(ortbRequest.imp[0].ext).to.not.equal(null);
+ expect(ortbRequest.imp[0].ext).to.deep.equal({
+ prebid: {
+ adzoneid: '77',
+ extra_key1: 'extra_val1',
+ extra_key2: 12345
+ },
+ data: {
+ pbadslot: 'homepage-top-rect',
+ adUnitSpecificAttribute: '123'
+ }
+ });
+ });
+
+ it('Verify bid request timeouts', function () {
+ const mkRequest = (bidderRequest) => spec.buildRequests(slotConfigs, bidderRequest).data;
+ // assert default is used when no bidderRequest.timeout value is available
+ expect(mkRequest(bidderRequest).tmax).to.equal(500)
+
+ // assert bidderRequest value is used when available
+ expect(mkRequest(Object.assign({}, { timeout: 6000 }, bidderRequest)).tmax).to.equal(6000)
+ });
});
diff --git a/test/spec/modules/adyoulikeBidAdapter_spec.js b/test/spec/modules/adyoulikeBidAdapter_spec.js
index de77c741364..ffd6729397a 100644
--- a/test/spec/modules/adyoulikeBidAdapter_spec.js
+++ b/test/spec/modules/adyoulikeBidAdapter_spec.js
@@ -2,6 +2,7 @@ import { expect } from 'chai';
import { spec } from 'modules/adyoulikeBidAdapter.js';
import { newBidder } from 'src/adapters/bidderFactory.js';
+import { config } from 'src/config.js';
describe('Adyoulike Adapter', function () {
const canonicalUrl = 'https://canonical.url/?t=%26';
@@ -887,4 +888,115 @@ describe('Adyoulike Adapter', function () {
expect(spec.gvlid).to.equal(259)
})
});
+
+ describe('getUserSyncs', function () {
+ const syncurl_iframe = 'https://visitor.omnitagjs.com/visitor/isync?uid=19340f4f097d16f41f34fc0274981ca4';
+
+ const emptySync = [];
+
+ describe('with iframe enabled', function() {
+ const userSyncConfig = { iframeEnabled: true };
+
+ it('should not add parameters if not provided', function() {
+ expect(spec.getUserSyncs(userSyncConfig, {}, undefined, undefined)).to.deep.equal([{
+ type: 'iframe', url: `${syncurl_iframe}`
+ }]);
+ });
+
+ it('should add GDPR parameters if provided', function() {
+ expect(spec.getUserSyncs(userSyncConfig, {}, {gdprApplies: true, consentString: undefined}, undefined)).to.deep.equal([{
+ type: 'iframe', url: `${syncurl_iframe}&gdpr=1&gdpr_consent=`
+ }]);
+
+ expect(spec.getUserSyncs(userSyncConfig, {}, {gdprApplies: true, consentString: 'foo?'}, undefined)).to.deep.equal([{
+ type: 'iframe', url: `${syncurl_iframe}&gdpr=1&gdpr_consent=foo%3F`
+ }]);
+ expect(spec.getUserSyncs(userSyncConfig, {}, {gdprApplies: false, consentString: 'bar'}, undefined)).to.deep.equal([{
+ type: 'iframe', url: `${syncurl_iframe}&gdpr=0&gdpr_consent=bar`
+ }]);
+ });
+
+ it('should add CCPA parameters if provided', function() {
+ expect(spec.getUserSyncs(userSyncConfig, {}, undefined, 'foo?')).to.deep.equal([{
+ type: 'iframe', url: `${syncurl_iframe}&us_privacy=foo%3F`
+ }]);
+ });
+
+ describe('COPPA', function() {
+ let sandbox;
+
+ this.beforeEach(function() {
+ sandbox = sinon.sandbox.create();
+ });
+
+ this.afterEach(function() {
+ sandbox.restore();
+ });
+
+ it('should add coppa parameters if provided', function() {
+ sandbox.stub(config, 'getConfig').callsFake(key => {
+ const config = {
+ 'coppa': true
+ };
+ return config[key];
+ });
+
+ expect(spec.getUserSyncs(userSyncConfig, {}, undefined, undefined)).to.deep.equal([{
+ type: 'iframe', url: `${syncurl_iframe}&coppa=1`
+ }]);
+ });
+ });
+
+ describe('GPP', function() {
+ it('should not apply if not gppConsent.gppString', function() {
+ const gppConsent = { gppString: '', applicableSections: [123] };
+ const result = spec.getUserSyncs(userSyncConfig, {}, undefined, undefined, gppConsent);
+ expect(result).to.deep.equal([{
+ type: 'iframe', url: `${syncurl_iframe}`
+ }]);
+ });
+
+ it('should not apply if not gppConsent.applicableSections', function() {
+ const gppConsent = { gppString: '', applicableSections: undefined };
+ const result = spec.getUserSyncs(userSyncConfig, {}, undefined, undefined, gppConsent);
+ expect(result).to.deep.equal([{
+ type: 'iframe', url: `${syncurl_iframe}`
+ }]);
+ });
+
+ it('should not apply if empty gppConsent.applicableSections', function() {
+ const gppConsent = { gppString: '', applicableSections: [] };
+ const result = spec.getUserSyncs(userSyncConfig, {}, undefined, undefined, gppConsent);
+ expect(result).to.deep.equal([{
+ type: 'iframe', url: `${syncurl_iframe}`
+ }]);
+ });
+
+ it('should apply if all above are available', function() {
+ const gppConsent = { gppString: 'foo?', applicableSections: [123] };
+ const result = spec.getUserSyncs(userSyncConfig, {}, undefined, undefined, gppConsent);
+ expect(result).to.deep.equal([{
+ type: 'iframe', url: `${syncurl_iframe}&gpp=foo%3F&gpp_sid=123`
+ }]);
+ });
+
+ it('should support multiple sections', function() {
+ const gppConsent = { gppString: 'foo', applicableSections: [123, 456] };
+ const result = spec.getUserSyncs(userSyncConfig, {}, undefined, undefined, gppConsent);
+ expect(result).to.deep.equal([{
+ type: 'iframe', url: `${syncurl_iframe}&gpp=foo&gpp_sid=123%2C456`
+ }]);
+ });
+ });
+ });
+
+ describe('with iframe disabled', function() {
+ const userSyncConfig = { iframeEnabled: false };
+
+ it('should return empty list of syncs', function() {
+ expect(spec.getUserSyncs(userSyncConfig, {}, undefined, undefined)).to.deep.equal(emptySync);
+ expect(spec.getUserSyncs(userSyncConfig, {}, {gdprApplies: true, consentString: 'foo'}, 'bar')).to.deep.equal(emptySync);
+ });
+ });
+ });
});
diff --git a/test/spec/modules/agmaAnalyticsAdapter_spec.js b/test/spec/modules/agmaAnalyticsAdapter_spec.js
new file mode 100644
index 00000000000..ba71624e3b3
--- /dev/null
+++ b/test/spec/modules/agmaAnalyticsAdapter_spec.js
@@ -0,0 +1,388 @@
+import adapterManager from '../../../src/adapterManager.js';
+import agmaAnalyticsAdapter, {
+ getTiming,
+ getOrtb2Data,
+ getPayload,
+} from '../../../modules/agmaAnalyticsAdapter.js';
+import { gdprDataHandler } from '../../../src/adapterManager.js';
+import { expect } from 'chai';
+import * as events from '../../../src/events.js';
+import constants from '../../../src/constants.json';
+import { generateUUID } from '../../../src/utils.js';
+import { server } from '../../mocks/xhr.js';
+import { config } from 'src/config.js';
+
+const INGEST_URL = 'https://pbc.agma-analytics.de/v1';
+const extendedKey = [
+ 'auctionIds',
+ 'code',
+ 'domain',
+ 'extended',
+ 'gdprApplies',
+ 'gdprConsentString',
+ 'language',
+ 'ortb2',
+ 'pageUrl',
+ 'pageViewId',
+ 'prebidVersion',
+ 'referrer',
+ 'screenHeight',
+ 'screenWidth',
+ 'scriptVersion',
+ 'timestamp',
+ 'timezoneOffset',
+ 'timing',
+ 'triggerEvent',
+ 'userIdsAsEids',
+];
+const nonExtendedKey = [
+ 'auctionIds',
+ 'code',
+ 'domain',
+ 'gdprApplies',
+ 'ortb2',
+ 'pageUrl',
+ 'pageViewId',
+ 'prebidVersion',
+ 'scriptVersion',
+ 'timing',
+ 'triggerEvent',
+];
+
+describe('AGMA Analytics Adapter', () => {
+ let agmaConfig, sandbox, clock;
+
+ beforeEach(() => {
+ sandbox = sinon.sandbox.create();
+ clock = sandbox.useFakeTimers();
+ sandbox.stub(events, 'getEvents').returns([]);
+ agmaConfig = {
+ options: {
+ code: 'test',
+ },
+ };
+ });
+
+ afterEach(() => {
+ sandbox.restore();
+ });
+
+ describe('configuration', () => {
+ it('registers itself with the adapter manager', () => {
+ const adapter = adapterManager.getAnalyticsAdapter('agma');
+ expect(adapter).to.exist;
+ expect(adapter.gvlid).to.equal(1122);
+ });
+ });
+
+ describe('getPayload', () => {
+ it('should use non extended payload with no consent info', () => {
+ sandbox.stub(gdprDataHandler, 'getConsentData').callsFake(() => null)
+ const payload = getPayload([generateUUID()], {
+ code: 'test',
+ });
+
+ expect(payload).to.have.all.keys([...nonExtendedKey, 'debug']);
+ });
+
+ it('should use non extended payload when agma is not in the TC String', () => {
+ sandbox.stub(gdprDataHandler, 'getConsentData').callsFake(() => ({
+ vendorData: {
+ vendor: {
+ consents: {
+ 1122: false,
+ },
+ },
+ },
+ }));
+ const payload = getPayload([generateUUID()], {
+ code: 'test',
+ });
+ expect(payload).to.have.all.keys([...nonExtendedKey, 'debug']);
+ });
+
+ it('should use extended payload when agma is in the TC String', () => {
+ sandbox.stub(gdprDataHandler, 'getConsentData').callsFake(() => ({
+ vendorData: {
+ vendor: {
+ consents: {
+ 1122: true,
+ },
+ },
+ },
+ }));
+ const payload = getPayload([generateUUID()], {
+ code: 'test',
+ });
+ expect(payload).to.have.all.keys([...extendedKey, 'debug']);
+ });
+ });
+
+ describe('getTiming', () => {
+ let originalPerformance;
+ let originalWindowPerformanceNow;
+
+ beforeEach(() => {
+ originalPerformance = global.performance;
+ originalWindowPerformanceNow = window.performance.now;
+ });
+
+ afterEach(() => {
+ global.performance = originalPerformance;
+ window.performance.now = originalWindowPerformanceNow;
+ });
+
+ it('returns TTFB using Timing API V2', () => {
+ global.performance = {
+ getEntriesByType: sinon
+ .stub()
+ .returns([{ responseStart: 100, startTime: 50 }]),
+ now: sinon.stub().returns(150),
+ };
+
+ const result = getTiming();
+
+ expect(result).to.deep.equal({ ttfb: 50, elapsedTime: 150 });
+ });
+
+ it('returns TTFB using Timing API V1 when V2 is not available', () => {
+ global.performance = {
+ getEntriesByType: sinon.stub().throws(),
+ timing: { responseStart: 150, fetchStart: 50 },
+ now: sinon.stub().returns(200),
+ };
+
+ const result = getTiming();
+
+ expect(result).to.deep.equal({ ttfb: 100, elapsedTime: 200 });
+ });
+
+ it('returns null when Timing API is not available', () => {
+ global.performance = {
+ getEntriesByType: sinon.stub().throws(),
+ timing: undefined,
+ };
+
+ const result = getTiming();
+
+ expect(result).to.be.null;
+ });
+
+ it('returns ttfb as 0 if calculated value is negative', () => {
+ global.performance = {
+ getEntriesByType: sinon
+ .stub()
+ .returns([{ responseStart: 50, startTime: 150 }]),
+ now: sinon.stub().returns(200),
+ };
+
+ const result = getTiming();
+
+ expect(result).to.deep.equal({ ttfb: 0, elapsedTime: 200 });
+ });
+
+ it('returns ttfb as 0 if calculated value exceeds performance.now()', () => {
+ global.performance = {
+ getEntriesByType: sinon
+ .stub()
+ .returns([{ responseStart: 50, startTime: 0 }]),
+ now: sinon.stub().returns(40),
+ };
+
+ const result = getTiming();
+
+ expect(result).to.deep.equal({ ttfb: 0, elapsedTime: 40 });
+ });
+ });
+
+ describe('getOrtb2Data', () => {
+ it('returns site and user from options when available', () => {
+ sandbox.stub(config, 'getConfig').callsFake((key) => {
+ return {};
+ });
+
+ const ortb2 = {
+ user: 'user',
+ site: 'site',
+ };
+
+ const result = getOrtb2Data({
+ ortb2,
+ });
+
+ expect(result).to.deep.equal(ortb2);
+ });
+
+ it('returns a combination of data from options and pGlobal.readConfig', () => {
+ sandbox.stub(config, 'getConfig').callsFake((key) => {
+ return {
+ ortb2: {
+ site: {
+ foo: 'bar',
+ },
+ },
+ };
+ });
+
+ const ortb2 = {
+ user: 'user',
+ };
+ const result = getOrtb2Data({
+ ortb2,
+ });
+
+ expect(result).to.deep.equal({
+ site: {
+ foo: 'bar',
+ },
+ user: 'user',
+ });
+ });
+ });
+
+ describe('Event Payload', () => {
+ beforeEach(() => {
+ agmaAnalyticsAdapter.enableAnalytics({
+ ...agmaConfig,
+ });
+ server.respondWith('POST', INGEST_URL, [
+ 200,
+ {
+ 'Content-Type': 'application/json',
+ 'Access-Control-Allow-Origin': '*',
+ },
+ '',
+ ]);
+ });
+
+ afterEach(() => {
+ agmaAnalyticsAdapter.auctionIds = [];
+ if (agmaAnalyticsAdapter.timer) {
+ clearTimeout(agmaAnalyticsAdapter.timer);
+ }
+ agmaAnalyticsAdapter.disableAnalytics();
+ });
+
+ it('should only send once per minute', () => {
+ sandbox.stub(gdprDataHandler, 'getConsentData').callsFake(() => ({
+ gdprApplies: true,
+ consentString: 'consentDataString',
+ vendorData: {
+ vendor: {
+ consents: {
+ 1122: true,
+ },
+ },
+ },
+ }));
+ const auction = {
+ auctionId: generateUUID(),
+ };
+
+ events.emit(constants.EVENTS.AUCTION_INIT, {
+ auctionId: generateUUID('1'),
+ auction,
+ });
+
+ clock.tick(200);
+
+ events.emit(constants.EVENTS.AUCTION_INIT, {
+ auctionId: generateUUID('2'),
+ auction,
+ });
+ events.emit(constants.EVENTS.AUCTION_INIT, {
+ auctionId: generateUUID('3'),
+ auction,
+ });
+ events.emit(constants.EVENTS.AUCTION_INIT, {
+ auctionId: generateUUID('4'),
+ auction,
+ });
+
+ clock.tick(900);
+
+ const [request] = server.requests;
+ const requestBody = JSON.parse(request.requestBody);
+ expect(request.url).to.equal(INGEST_URL);
+ expect(requestBody).to.have.all.keys(extendedKey);
+ expect(requestBody.triggerEvent).to.equal(constants.EVENTS.AUCTION_INIT);
+ expect(server.requests).to.have.length(1);
+ });
+
+ it('should send the extended payload with consent', () => {
+ sandbox.stub(gdprDataHandler, 'getConsentData').callsFake(() => ({
+ gdprApplies: true,
+ consentString: 'consentDataString',
+ vendorData: {
+ vendor: {
+ consents: {
+ 1122: true,
+ },
+ },
+ },
+ }));
+ const auction = {
+ auctionId: generateUUID(),
+ };
+
+ events.emit(constants.EVENTS.AUCTION_INIT, auction);
+ clock.tick(1100);
+
+ const [request] = server.requests;
+ const requestBody = JSON.parse(request.requestBody);
+ expect(request.url).to.equal(INGEST_URL);
+ expect(requestBody).to.have.all.keys(extendedKey);
+ expect(requestBody.triggerEvent).to.equal(constants.EVENTS.AUCTION_INIT);
+ expect(server.requests).to.have.length(1);
+ expect(agmaAnalyticsAdapter.auctionIds).to.have.length(0);
+ });
+
+ it('should send the non extended payload with no explicit consent', () => {
+ sandbox.stub(gdprDataHandler, 'getConsentData').callsFake(() => ({
+ gdprApplies: true,
+ consentString: 'consentDataString',
+ }));
+
+ const auction = {
+ auctionId: generateUUID(),
+ };
+
+ events.emit(constants.EVENTS.AUCTION_INIT, auction);
+ clock.tick(1000);
+
+ const [request] = server.requests;
+ const requestBody = JSON.parse(request.requestBody);
+ expect(request.url).to.equal(INGEST_URL);
+ expect(requestBody.triggerEvent).to.equal(constants.EVENTS.AUCTION_INIT);
+ expect(server.requests).to.have.length(1);
+ expect(agmaAnalyticsAdapter.auctionIds).to.have.length(0);
+ });
+
+ it('should set the trigger Event', () => {
+ sandbox.stub(gdprDataHandler, 'getConsentData').callsFake(() => null);
+ agmaAnalyticsAdapter.disableAnalytics();
+ agmaAnalyticsAdapter.enableAnalytics({
+ provider: 'agma',
+ options: {
+ code: 'test',
+ triggerEvent: constants.EVENTS.AUCTION_END
+ },
+ });
+ const auction = {
+ auctionId: generateUUID(),
+ };
+
+ events.emit(constants.EVENTS.AUCTION_INIT, auction);
+ events.emit(constants.EVENTS.AUCTION_END, auction);
+ clock.tick(1000);
+
+ const [request] = server.requests;
+ const requestBody = JSON.parse(request.requestBody);
+ expect(request.url).to.equal(INGEST_URL);
+ expect(requestBody.auctionIds).to.have.length(1);
+ expect(requestBody.triggerEvent).to.equal(constants.EVENTS.AUCTION_END);
+ expect(server.requests).to.have.length(1);
+ expect(agmaAnalyticsAdapter.auctionIds).to.have.length(0);
+ });
+ });
+});
diff --git a/test/spec/modules/ajaBidAdapter_spec.js b/test/spec/modules/ajaBidAdapter_spec.js
index 7cf5698f7d4..3137c9dc24e 100644
--- a/test/spec/modules/ajaBidAdapter_spec.js
+++ b/test/spec/modules/ajaBidAdapter_spec.js
@@ -62,8 +62,17 @@ describe('AjaAdapter', function () {
model: 'SM-G955U',
bitness: '64',
architecture: ''
+ },
+ ext: {
+ cdep: 'example_label_1'
}
}
+ },
+ ortb2Imp: {
+ ext: {
+ tid: 'cea1eb09-d970-48dc-8585-634d3a7b0544',
+ gpid: '/1111/homepage#300x250'
+ }
}
}
];
@@ -78,7 +87,7 @@ describe('AjaAdapter', function () {
const requests = spec.buildRequests(bidRequests, bidderRequest);
expect(requests[0].url).to.equal(ENDPOINT);
expect(requests[0].method).to.equal('GET');
- expect(requests[0].data).to.equal('asi=123456&skt=5&prebid_id=30b31c1838de1e&prebid_ver=$prebid.version$&page_url=https%3A%2F%2Fhoge.com&sua=%7B%22source%22%3A2%2C%22platform%22%3A%7B%22brand%22%3A%22Android%22%2C%22version%22%3A%5B%228%22%2C%220%22%2C%220%22%5D%7D%2C%22browsers%22%3A%5B%7B%22brand%22%3A%22Not_A%20Brand%22%2C%22version%22%3A%5B%2299%22%2C%220%22%2C%220%22%2C%220%22%5D%7D%2C%7B%22brand%22%3A%22Google%20Chrome%22%2C%22version%22%3A%5B%22109%22%2C%220%22%2C%225414%22%2C%22119%22%5D%7D%2C%7B%22brand%22%3A%22Chromium%22%2C%22version%22%3A%5B%22109%22%2C%220%22%2C%225414%22%2C%22119%22%5D%7D%5D%2C%22mobile%22%3A1%2C%22model%22%3A%22SM-G955U%22%2C%22bitness%22%3A%2264%22%2C%22architecture%22%3A%22%22%7D&');
+ expect(requests[0].data).to.equal('asi=123456&skt=5&gpid=%2F1111%2Fhomepage%23300x250&tid=cea1eb09-d970-48dc-8585-634d3a7b0544&cdep=example_label_1&prebid_id=30b31c1838de1e&prebid_ver=$prebid.version$&page_url=https%3A%2F%2Fhoge.com&ad_format_ids=2&sua=%7B%22source%22%3A2%2C%22platform%22%3A%7B%22brand%22%3A%22Android%22%2C%22version%22%3A%5B%228%22%2C%220%22%2C%220%22%5D%7D%2C%22browsers%22%3A%5B%7B%22brand%22%3A%22Not_A%20Brand%22%2C%22version%22%3A%5B%2299%22%2C%220%22%2C%220%22%2C%220%22%5D%7D%2C%7B%22brand%22%3A%22Google%20Chrome%22%2C%22version%22%3A%5B%22109%22%2C%220%22%2C%225414%22%2C%22119%22%5D%7D%2C%7B%22brand%22%3A%22Chromium%22%2C%22version%22%3A%5B%22109%22%2C%220%22%2C%225414%22%2C%22119%22%5D%7D%5D%2C%22mobile%22%3A1%2C%22model%22%3A%22SM-G955U%22%2C%22bitness%22%3A%2264%22%2C%22architecture%22%3A%22%22%7D&');
});
});
@@ -116,7 +125,7 @@ describe('AjaAdapter', function () {
const requests = spec.buildRequests(bidRequests, bidderRequest);
expect(requests[0].url).to.equal(ENDPOINT);
expect(requests[0].method).to.equal('GET');
- expect(requests[0].data).to.equal('asi=123456&skt=5&prebid_id=30b31c1838de1e&prebid_ver=$prebid.version$&page_url=https%3A%2F%2Fhoge.com&eids=%7B%22eids%22%3A%5B%7B%22source%22%3A%22pubcid.org%22%2C%22uids%22%3A%5B%7B%22id%22%3A%22some-random-id-value%22%2C%22atype%22%3A1%7D%5D%7D%5D%7D&');
+ expect(requests[0].data).to.equal('asi=123456&skt=5&prebid_id=30b31c1838de1e&prebid_ver=$prebid.version$&page_url=https%3A%2F%2Fhoge.com&ad_format_ids=2&eids=%7B%22eids%22%3A%5B%7B%22source%22%3A%22pubcid.org%22%2C%22uids%22%3A%5B%7B%22id%22%3A%22some-random-id-value%22%2C%22atype%22%3A1%7D%5D%7D%5D%7D&');
});
});
@@ -173,138 +182,6 @@ describe('AjaAdapter', function () {
expect(Object.keys(result[0])).to.have.members(Object.keys(expectedResponse[0]));
});
- it('handles video responses', function () {
- let response = {
- 'is_ad_return': true,
- 'ad': {
- 'ad_type': 3,
- 'prebid_id': '51ef8751f9aead',
- 'price': 12.34,
- 'currency': 'JPY',
- 'creative_id': '123abc',
- 'video': {
- 'w': 300,
- 'h': 250,
- 'vtag': 'vast ')
+ expect(result[0]).to.have.property('vastUrl').equal('http://test.com?price=800.4')
expect(result[0].meta).to.exist.property('advertiserDomains')
expect(result[0].meta).to.have.property('advertiserDomains').lengthOf(1)
})
diff --git a/test/spec/modules/ampliffyBidAdapter_spec.js b/test/spec/modules/ampliffyBidAdapter_spec.js
new file mode 100644
index 00000000000..5b86f692d7e
--- /dev/null
+++ b/test/spec/modules/ampliffyBidAdapter_spec.js
@@ -0,0 +1,453 @@
+import {
+ parseXML,
+ isAllowedToBidUp,
+ spec,
+ getDefaultParams,
+ mergeParams,
+ paramsToQueryString, setCurrentURL
+} from 'modules/ampliffyBidAdapter.js';
+import {expect} from 'chai';
+import {BANNER, VIDEO} from 'src/mediaTypes';
+import {newBidder} from 'src/adapters/bidderFactory';
+
+describe('Ampliffy bid adapter Test', function () {
+ const adapter = newBidder(spec);
+
+ describe('inherited functions', function () {
+ it('exists and is a function', function () {
+ expect(adapter.callBids).to.exist.and.to.be.a('function');
+ });
+ });
+ // Global definitions for all tests
+ const xmlStr = `
+
+
+
+ ]]>
+
+
+ ES `;
+ const xml = new window.DOMParser().parseFromString(xmlStr, 'text/xml');
+ let companion = xml.getElementsByTagName('Companion')[0];
+ let htmlResource = companion.getElementsByTagName('HTMLResource')[0];
+ let htmlContent = document.createElement('html');
+ htmlContent.innerHTML = htmlResource.textContent;
+
+ describe('Is allowed to bid up', function () {
+ it('Should return true using a URL that is in domainMap', () => {
+ let allowedToBidUp = isAllowedToBidUp(htmlContent, 'https://testSports.com?id=131313&text=aaaaa&foo=foo');
+ expect(allowedToBidUp).to.be.true;
+ })
+
+ it('Should return false using an url that is not in domainMap', () => {
+ let allowedToBidUp = isAllowedToBidUp(htmlContent, 'https://test.com');
+ expect(allowedToBidUp).to.be.false;
+ })
+
+ it('Should return false using an url that is excluded.', () => {
+ let allowedToBidUp = isAllowedToBidUp(htmlContent, 'https://www.no-allowed.com/busqueda/sexo/sexo?test=1#item1');
+ expect(allowedToBidUp).to.be.false;
+ })
+ })
+
+ describe('Helper functions', function () {
+ it('Should default params not to be null', () => {
+ const defaultParams = getDefaultParams();
+
+ expect(defaultParams).not.to.be.null;
+ })
+ it('Should the merge two object params into a new object', () => {
+ const params1 = {
+ 'hello': 'world',
+ 'ampTest': 'this will be replaced'
+ }
+ const params2 = {
+ 'test': 1,
+ 'ampTest': 'This will be replace the param with the same name in other array'
+ }
+ const allParams = mergeParams(params1, params2);
+
+ const paramsComplete =
+ {
+ 'hello': 'world',
+ 'ampTest': 'This will be replace the param with the same name in other array',
+ 'test': 1,
+ }
+ expect(allParams).not.to.be.null;
+ expect(JSON.stringify(allParams)).to.equal(JSON.stringify(paramsComplete));
+ })
+ it('Params to QueryString', () => {
+ const params = {
+ 'test': 1,
+ 'ampTest': 'ret',
+ 'empty': null,
+ 'quoteMark': '?',
+ 'test1': undefined
+ }
+ const queryString = paramsToQueryString(params);
+
+ expect(queryString).not.to.be.null;
+ expect(queryString).to.equal('test=1&Test=ret&empty"eMark=%3F');
+ })
+ })
+
+ describe('isBidRequestValid', function () {
+ it('Should return true when required params found', function () {
+ const bidRequest = {
+ bidder: 'ampliffy',
+ params: {
+ server: 'bidder.ampliffy.com',
+ placementId: 1235465798,
+ format: 'all'
+ },
+ mediaTypes: {
+ banner: {
+ sizes: [1, 1]
+ }
+ },
+ }
+ expect(spec.isBidRequestValid(bidRequest)).to.be.true;
+ })
+ it('Should return false when param format is display but mediaTypes are for video', function () {
+ const bidRequest = {
+ bidder: 'ampliffy',
+ params: {
+ server: 'bidder.ampliffy.com',
+ placementId: 1235465798,
+ format: 'display'
+ },
+ mediaTypes: {
+ video: {
+ sizes: [1, 1]
+ }
+ },
+ }
+ expect(spec.isBidRequestValid(bidRequest)).to.be.false;
+ })
+ it('Should return false when param format is video but mediaTypes are for banner', function () {
+ const bidRequest = {
+ bidder: 'ampliffy',
+ params: {
+ server: 'bidder.ampliffy.com',
+ placementId: 1235465798,
+ format: 'video'
+ },
+ mediaTypes: {
+ banner: {
+ sizes: [1, 1]
+ }
+ },
+ }
+ expect(spec.isBidRequestValid(bidRequest)).to.be.false;
+ })
+ it('Should return true when param format is video and mediaTypes are for video', function () {
+ const bidRequest = {
+ bidder: 'ampliffy',
+ params: {
+ server: 'bidder.ampliffy.com',
+ placementId: 1235465798,
+ format: 'video'
+ },
+ mediaTypes: {
+ video: {
+ sizes: [1, 1]
+ }
+ },
+ }
+ expect(spec.isBidRequestValid(bidRequest)).to.be.true;
+ })
+ it('Should return true when param format is display and mediaTypes are for banner', function () {
+ const bidRequest = {
+ bidder: 'ampliffy',
+ params: {
+ server: 'bidder.ampliffy.com',
+ placementId: 1235465798,
+ format: 'display'
+ },
+ mediaTypes: {
+ banner: {
+ sizes: [1, 1]
+ }
+ },
+ }
+ expect(spec.isBidRequestValid(bidRequest)).to.be.true;
+ })
+ it('Should return true when param format is all and mediaTypes are for banner', function () {
+ const bidRequest = {
+ bidder: 'ampliffy',
+ params: {
+ server: 'bidder.ampliffy.com',
+ placementId: 1235465798,
+ format: 'all'
+ },
+ mediaTypes: {
+ banner: {
+ sizes: [1, 1]
+ }
+ },
+ }
+ expect(spec.isBidRequestValid(bidRequest)).to.be.true;
+ })
+ it('Should return true when param format is all and mediaTypes are for video', function () {
+ const bidRequest = {
+ bidder: 'ampliffy',
+ params: {
+ server: 'bidder.ampliffy.com',
+ placementId: 1235465798,
+ format: 'all'
+ },
+ mediaTypes: {
+ video: {
+ sizes: [1, 1]
+ }
+ },
+ }
+ expect(spec.isBidRequestValid(bidRequest)).to.be.true;
+ })
+ it('Should return false without placementId param', function () {
+ const bidRequest = {
+ bidder: 'ampliffy',
+ params: {}
+ }
+ expect(spec.isBidRequestValid(bidRequest)).to.be.false;
+ })
+ it('Should return false without param object', function () {
+ const bidRequest = {
+ bidder: 'ampliffy',
+ }
+ expect(spec.isBidRequestValid(bidRequest)).to.be.false;
+ })
+ });
+
+ describe('Build request function', function () {
+ const bidderRequest = {
+ 'bidderCode': 'ampliffy',
+ 'auctionId': 'c4a771bf-1791-4513-82b3-96c48d19ddff',
+ 'bidderRequestId': '1134bdcbe47f25',
+ 'bids': [{
+ 'bidder': 'ampliffy',
+ 'params': {
+ 'placementId': 1235465798,
+ 'type': 'bidder.',
+ 'region': 'alan-development.k8s.',
+ 'adnetwork': 'ampliffy.com',
+ 'SERVER': 'bidder.ampliffy.com'
+ },
+ 'crumbs': {'pubcid': '29844d69-c4e5-4b00-8602-6dd09815363a'},
+ 'ortb2Imp': {'ext': {'data': {'pbadslot': 'video1'}}},
+ 'mediaTypes': {
+ 'video': {
+ 'context': 'instream',
+ 'playerSize': [[640, 480]],
+ 'mimes': ['video/mp4'],
+ 'protocols': [1, 2, 3, 4, 5, 6, 7, 8],
+ 'playbackmethod': [2],
+ 'skip': 1
+ }
+ },
+ 'adUnitCode': 'video1',
+ 'transactionId': 'f85c1b10-bad3-4c3f-a2bb-2c484c405bc9',
+ 'sizes': [[640, 480]],
+ 'bidId': '2bc71d9c058842',
+ 'bidderRequestId': '1134bdcbe47f25',
+ 'auctionId': 'c4a771bf-1791-4513-82b3-96c48d19ddff',
+ 'src': 'client',
+ 'bidRequestsCount': 1,
+ 'bidderRequestsCount': 1,
+ 'bidderWinsCount': 0
+ }],
+ 'auctionStart': 1644029483655,
+ 'timeout': 3000,
+ 'refererInfo': {
+ 'referer': 'http://localhost:9999/integrationExamples/gpt/hello_world_video.html?pbjs_debug=true',
+ 'reachedTop': true,
+ 'isAmp': false,
+ 'numIframes': 0,
+ 'stack': ['http://localhost:9999/integrationExamples/gpt/hello_world_video.html?pbjs_debug=true'],
+ 'canonicalUrl': null
+ },
+ 'start': 1644029483708
+ }
+ const validBidRequests = [
+ {
+ 'bidder': 'ampliffy',
+ 'params': {
+ 'placementId': 1235465798,
+ 'type': 'bidder.',
+ 'region': 'alan-development.k8s.',
+ 'adnetwork': 'ampliffy.com',
+ 'SERVER': 'bidder.ampliffy.com'
+ },
+ 'crumbs': {'pubcid': '29844d69-c4e5-4b00-8602-6dd09815363a'},
+ 'ortb2Imp': {'ext': {'data': {'pbadslot': 'video1'}}},
+ 'mediaTypes': {
+ 'video': {
+ 'context': 'instream',
+ 'playerSize': [[640, 480]],
+ 'mimes': ['video/mp4'],
+ 'protocols': [1, 2, 3, 4, 5, 6, 7, 8],
+ 'playbackmethod': [2],
+ 'skip': 1
+ }
+ },
+ 'adUnitCode': 'video1',
+ 'transactionId': 'f85c1b10-bad3-4c3f-a2bb-2c484c405bc9',
+ 'sizes': [[640, 480]],
+ 'bidId': '2bc71d9c058842',
+ 'bidderRequestId': '1134bdcbe47f25',
+ 'auctionId': 'c4a771bf-1791-4513-82b3-96c48d19ddff',
+ 'src': 'client',
+ 'bidRequestsCount': 1,
+ 'bidderRequestsCount': 1,
+ 'bidderWinsCount': 0
+ }
+ ];
+ it('Should return one or more bid requests', function () {
+ expect(spec.buildRequests(validBidRequests, bidderRequest).length).to.be.greaterThan(0);
+ });
+ })
+ describe('Interpret response', function () {
+ let bidRequest = {
+ bidRequest: {
+ adUnitCode: 'div-gpt-ad-1460505748561-0',
+ auctionId: '469bb2e2-351f-4d01-b782-cdbca5e3e0ed',
+ bidId: '2d40b8dcd02ade',
+ bidRequestsCount: 1,
+ bidder: 'ampliffy',
+ bidderRequestId: '128c07edc4680f',
+ bidderRequestsCount: 1,
+ bidderWinsCount: 0,
+ crumbs: {
+ pubcid: '29844d69-c4e5-4b00-8602-6dd09815363a'
+ },
+ mediaTypes: {
+ banner: {
+ sizes: [
+ [300, 250],
+ [300, 600]
+ ]
+ }
+ },
+ ortb2Imp: {ext: {}},
+ params: {placementId: 13144370},
+ sizes: [
+ [300, 250],
+ [300, 600]
+ ],
+ src: 'client',
+ transactionId: '103b2b58-6ed1-45e9-9486-c942d6042e3'
+ },
+ data: {bidId: '2d40b8dcd02ade'},
+ method: 'GET',
+ url: 'https://test.com',
+ };
+
+ it('Should extract a CPM and currency from the xml', () => {
+ let cpmData = parseXML(xml);
+ expect(cpmData).to.not.be.a('null');
+ expect(cpmData.cpm).to.equal('.23');
+ expect(cpmData.currency).to.equal('USD');
+ });
+
+ it('It should return no ads when the CPM is less than zero.', () => {
+ const xmlStr1 = `
+
+
+
+
+
+
+
+
+
+
+
+ ES
+
+ `;
+ let serverResponse = {
+ 'body': xmlStr1,
+ }
+ const bidResponses = spec.interpretResponse(serverResponse, bidRequest);
+ expect(bidResponses.length).to.equal(0);
+ })
+
+ it('It should return no ads when the creative url is not in the xml', () => {
+ const xmlStr1 = `
+
+
+
+
+
+
+
+
+
+
ad
',
+ adId: 'fake_ad_id_2',
+ bid: BID_ANOTHER
+ },
+ bidcached: {
+ ad: 'ad
',
+ adId: 'fake_ad_id_2',
+ bid: BID_CACHED
+ }
+ },
+ AD_RENDER_FAILED: {
+ bidcached: {
+ adId: 'fake_ad_id_2',
+ bid: BID_CACHED
+ }
+ }
+};
+
+describe('adagio analytics adapter', () => {
+ let sandbox;
+
+ beforeEach(() => {
+ sandbox = sinon.sandbox.create();
+
+ sandbox.stub(events, 'getEvents').returns([]);
+
+ adapterManager.registerAnalyticsAdapter({
+ code: 'adagio',
+ adapter: adagioAnalyticsAdapter
+ });
+ });
+
+ afterEach(() => {
+ sandbox.restore();
+ });
+
+ describe('track', () => {
+ beforeEach(() => {
+ adapterManager.enableAnalytics({
+ provider: 'adagio'
+ });
+ });
+
+ afterEach(() => {
+ adagioAnalyticsAdapter.disableAnalytics();
+ });
+
+ it('builds and sends auction data', () => {
+ getGlobal().convertCurrency = (cpm, from, to) => {
+ const convKeys = {
+ 'GBP-EUR': 0.7,
+ 'EUR-GBP': 1.3,
+ 'USD-EUR': 0.8,
+ 'EUR-USD': 1.2,
+ 'USD-GBP': 0.6,
+ 'GBP-USD': 1.6,
+ };
+ return cpm * (convKeys[`${from}-${to}`] || 1);
+ };
+
+ events.emit(constants.EVENTS.AUCTION_INIT, MOCK.AUCTION_INIT.another);
+ events.emit(constants.EVENTS.BID_RESPONSE, MOCK.BID_RESPONSE.adagio);
+ events.emit(constants.EVENTS.BID_RESPONSE, MOCK.BID_RESPONSE.another);
+ events.emit(constants.EVENTS.AUCTION_END, MOCK.AUCTION_END.another);
+ events.emit(constants.EVENTS.BID_WON, MOCK.BID_WON.another);
+ events.emit(constants.EVENTS.AD_RENDER_SUCCEEDED, MOCK.AD_RENDER_SUCCEEDED.another);
+
+ expect(server.requests.length).to.equal(3, 'requests count');
+ {
+ const { protocol, hostname, pathname, search } = utils.parseUrl(server.requests[0].url);
+ expect(protocol).to.equal('https');
+ expect(hostname).to.equal('c.4dex.io');
+ expect(pathname).to.equal('/pba.gif');
+ expect(search.v).to.equal('1');
+ expect(search.pbjsv).to.equal('$prebid.version$');
+ expect(search.auct_id).to.equal(AUCTION_ID_ADAGIO);
+ expect(search.adu_code).to.equal('/19968336/header-bid-tag-1');
+ expect(search.org_id).to.equal('1001');
+ expect(search.site).to.equal('test-com');
+ expect(search.pv_id).to.equal('a68e6d70-213b-496c-be0a-c468ff387106');
+ expect(search.url_dmn).to.equal(window.location.hostname);
+ expect(search.pgtyp).to.equal('article');
+ expect(search.plcmt).to.equal('pave_top');
+ expect(search.mts).to.equal('ban');
+ expect(search.ban_szs).to.equal('640x100,640x480');
+ expect(search.bdrs).to.equal('adagio,another,nobid');
+ expect(search.adg_mts).to.equal('ban');
+ }
+
+ {
+ const { protocol, hostname, pathname, search } = utils.parseUrl(server.requests[1].url);
+ expect(protocol).to.equal('https');
+ expect(hostname).to.equal('c.4dex.io');
+ expect(pathname).to.equal('/pba.gif');
+ expect(search.v).to.equal('2');
+ expect(search.e_sid).to.equal('42');
+ expect(search.e_pba_test).to.equal('true');
+ expect(search.bdrs_bid).to.equal('1,1,0');
+ }
+
+ {
+ const { protocol, hostname, pathname, search } = utils.parseUrl(server.requests[2].url);
+ expect(protocol).to.equal('https');
+ expect(hostname).to.equal('c.4dex.io');
+ expect(pathname).to.equal('/pba.gif');
+ expect(search.v).to.equal('3');
+ expect(search.auct_id).to.equal(AUCTION_ID_ADAGIO);
+ expect(search.adu_code).to.equal('/19968336/header-bid-tag-1');
+ expect(search.win_bdr).to.equal('another');
+ expect(search.win_mt).to.equal('ban');
+ expect(search.win_ban_sz).to.equal('728x90');
+ expect(search.win_cpm).to.equal('1.71');
+ expect(search.cur).to.equal('EUR');
+ expect(search.cur_rate).to.equal('1.2');
+ expect(search.og_cpm).to.equal('1.62');
+ expect(search.og_cur).to.equal('GBP');
+ expect(search.og_cur_rate).to.equal('1.6');
+ }
+ });
+
+ it('builds and sends auction data with a cached bid win', () => {
+ getGlobal().convertCurrency = (cpm, from, to) => {
+ const convKeys = {
+ 'GBP-EUR': 0.7,
+ 'EUR-GBP': 1.3,
+ 'USD-EUR': 0.8,
+ 'EUR-USD': 1.2,
+ 'USD-GBP': 0.6,
+ 'GBP-USD': 1.6,
+ };
+ return cpm * (convKeys[`${from}-${to}`] || 1);
+ };
+
+ events.emit(constants.EVENTS.AUCTION_INIT, MOCK.AUCTION_INIT.bidcached);
+ events.emit(constants.EVENTS.AUCTION_INIT, MOCK.AUCTION_INIT.another);
+ events.emit(constants.EVENTS.BID_RESPONSE, MOCK.BID_RESPONSE.adagio);
+ events.emit(constants.EVENTS.BID_RESPONSE, MOCK.BID_RESPONSE.another);
+ events.emit(constants.EVENTS.AUCTION_END, MOCK.AUCTION_END.another_nobid);
+ events.emit(constants.EVENTS.BID_WON, MOCK.BID_WON.bidcached);
+ events.emit(constants.EVENTS.AD_RENDER_FAILED, MOCK.AD_RENDER_FAILED.bidcached);
+
+ expect(server.requests.length).to.equal(5, 'requests count');
+ {
+ const { protocol, hostname, pathname, search } = utils.parseUrl(server.requests[0].url);
+ expect(protocol).to.equal('https');
+ expect(hostname).to.equal('c.4dex.io');
+ expect(pathname).to.equal('/pba.gif');
+ expect(search.v).to.equal('1');
+ expect(search.pbjsv).to.equal('$prebid.version$');
+ expect(search.auct_id).to.equal(AUCTION_ID_CACHE_ADAGIO);
+ expect(search.adu_code).to.equal('/19968336/header-bid-tag-1');
+ expect(search.org_id).to.equal('1001');
+ expect(search.site).to.equal('test-com');
+ expect(search.pv_id).to.equal('a68e6d70-213b-496c-be0a-c468ff387106');
+ expect(search.url_dmn).to.equal(window.location.hostname);
+ expect(search.pgtyp).to.equal('article');
+ expect(search.plcmt).to.equal('pave_top');
+ expect(search.mts).to.equal('ban');
+ expect(search.ban_szs).to.equal('640x100,640x480');
+ expect(search.bdrs).to.equal('adagio,another');
+ expect(search.adg_mts).to.equal('ban');
+ expect(search.t_n).to.equal('test');
+ expect(search.t_v).to.equal('version');
+ }
+
+ {
+ const { protocol, hostname, pathname, search } = utils.parseUrl(server.requests[1].url);
+ expect(protocol).to.equal('https');
+ expect(hostname).to.equal('c.4dex.io');
+ expect(pathname).to.equal('/pba.gif');
+ expect(search.v).to.equal('1');
+ expect(search.pbjsv).to.equal('$prebid.version$');
+ expect(search.auct_id).to.equal(AUCTION_ID_ADAGIO);
+ expect(search.adu_code).to.equal('/19968336/header-bid-tag-1');
+ expect(search.org_id).to.equal('1001');
+ expect(search.site).to.equal('test-com');
+ expect(search.pv_id).to.equal('a68e6d70-213b-496c-be0a-c468ff387106');
+ expect(search.url_dmn).to.equal(window.location.hostname);
+ expect(search.pgtyp).to.equal('article');
+ expect(search.plcmt).to.equal('pave_top');
+ expect(search.mts).to.equal('ban');
+ expect(search.ban_szs).to.equal('640x100,640x480');
+ expect(search.bdrs).to.equal('adagio,another,nobid');
+ expect(search.adg_mts).to.equal('ban');
+ }
+
+ {
+ const { protocol, hostname, pathname, search } = utils.parseUrl(server.requests[2].url);
+ expect(protocol).to.equal('https');
+ expect(hostname).to.equal('c.4dex.io');
+ expect(pathname).to.equal('/pba.gif');
+ expect(search.v).to.equal('2');
+ expect(search.e_sid).to.equal('42');
+ expect(search.e_pba_test).to.equal('true');
+ expect(search.bdrs_bid).to.equal('0,0,0');
+ }
+
+ {
+ const { protocol, hostname, pathname, search } = utils.parseUrl(server.requests[3].url);
+ expect(protocol).to.equal('https');
+ expect(hostname).to.equal('c.4dex.io');
+ expect(pathname).to.equal('/pba.gif');
+ expect(search.v).to.equal('3');
+ expect(search.auct_id).to.equal(AUCTION_ID_ADAGIO);
+ expect(search.auct_id_c).to.equal(AUCTION_ID_CACHE_ADAGIO);
+ expect(search.adu_code).to.equal('/19968336/header-bid-tag-1');
+ expect(search.win_bdr).to.equal('adagio');
+ expect(search.win_mt).to.equal('ban');
+ expect(search.win_ban_sz).to.equal('728x90');
+ expect(search.win_cpm).to.equal('1.42');
+ expect(search.cur).to.equal('USD');
+ expect(search.cur_rate).to.equal('1');
+ expect(search.og_cpm).to.equal('1.42');
+ expect(search.og_cur).to.equal('USD');
+ expect(search.og_cur_rate).to.equal('1');
+ expect(search.rndr).to.not.exist;
+ }
+
+ {
+ const { protocol, hostname, pathname, search } = utils.parseUrl(server.requests[4].url);
+ expect(protocol).to.equal('https');
+ expect(hostname).to.equal('c.4dex.io');
+ expect(pathname).to.equal('/pba.gif');
+ expect(search.v).to.equal('4');
+ expect(search.auct_id).to.equal(AUCTION_ID_ADAGIO);
+ expect(search.auct_id_c).to.equal(AUCTION_ID_CACHE_ADAGIO);
+ expect(search.adu_code).to.equal('/19968336/header-bid-tag-1');
+ expect(search.rndr).to.equal('0');
+ }
+ });
+ });
+});
diff --git a/test/spec/modules/adagioBidAdapter_spec.js b/test/spec/modules/adagioBidAdapter_spec.js
index 1f734a6a7fc..744f3c69e83 100644
--- a/test/spec/modules/adagioBidAdapter_spec.js
+++ b/test/spec/modules/adagioBidAdapter_spec.js
@@ -861,11 +861,6 @@ describe('Adagio bid adapter', () => {
}
const requests = spec.buildRequests([bid01], bidderRequest);
- expect(requests[0].data.adUnits[0].floors.length).to.equal(3);
- expect(requests[0].data.adUnits[0].floors[0]).to.deep.equal({f: 1, mt: 'banner', s: '300x250'});
- expect(requests[0].data.adUnits[0].floors[1]).to.deep.equal({f: 1, mt: 'banner', s: '300x600'});
- expect(requests[0].data.adUnits[0].floors[2]).to.deep.equal({f: 1, mt: 'video', s: '600x480'});
-
expect(requests[0].data.adUnits[0].mediaTypes.banner.sizes.length).to.equal(2);
expect(requests[0].data.adUnits[0].mediaTypes.banner.bannerSizes[0]).to.deep.equal({size: [300, 250], floor: 1});
expect(requests[0].data.adUnits[0].mediaTypes.banner.bannerSizes[1]).to.deep.equal({size: [300, 600], floor: 1});
@@ -890,10 +885,6 @@ describe('Adagio bid adapter', () => {
}
const requests = spec.buildRequests([bid01], bidderRequest);
- expect(requests[0].data.adUnits[0].floors.length).to.equal(2);
- expect(requests[0].data.adUnits[0].floors[0]).to.deep.equal({f: 1, mt: 'video'});
- expect(requests[0].data.adUnits[0].floors[1]).to.deep.equal({f: 1, mt: 'native'});
-
expect(requests[0].data.adUnits[0].mediaTypes.video.floor).to.equal(1);
expect(requests[0].data.adUnits[0].mediaTypes.native.floor).to.equal(1);
});
@@ -913,8 +904,6 @@ describe('Adagio bid adapter', () => {
}
const requests = spec.buildRequests([bid01], bidderRequest);
- expect(requests[0].data.adUnits[0].floors.length).to.equal(1);
- expect(requests[0].data.adUnits[0].floors[0]).to.deep.equal({mt: 'video'});
expect(requests[0].data.adUnits[0].mediaTypes.video.floor).to.be.undefined;
});
});
@@ -958,6 +947,34 @@ describe('Adagio bid adapter', () => {
expect(requests[0].data.usIfr).to.equal(false);
});
});
+
+ describe('with GPID', function () {
+ const gpid = '/12345/my-gpt-tag-0';
+
+ it('should add preferred gpid to the request', function () {
+ const bid01 = new BidRequestBuilder().withParams().build();
+ bid01.ortb2Imp = {
+ ext: {
+ gpid: gpid
+ }
+ };
+ const bidderRequest = new BidderRequestBuilder().build();
+ const requests = spec.buildRequests([bid01], bidderRequest);
+ expect(requests[0].data.adUnits[0].gpid).to.exist.and.equal(gpid);
+ });
+
+ it('should add backup gpid to the request', function () {
+ const bid01 = new BidRequestBuilder().withParams().build();
+ bid01.ortb2Imp = {
+ ext: {
+ data: { pbadslot: gpid }
+ }
+ };
+ const bidderRequest = new BidderRequestBuilder().build();
+ const requests = spec.buildRequests([bid01], bidderRequest);
+ expect(requests[0].data.adUnits[0].gpid).to.exist.and.equal(gpid);
+ });
+ });
});
describe('interpretResponse()', function() {
diff --git a/test/spec/modules/adfusionBidAdapter_spec.js b/test/spec/modules/adfusionBidAdapter_spec.js
new file mode 100644
index 00000000000..638831c33f3
--- /dev/null
+++ b/test/spec/modules/adfusionBidAdapter_spec.js
@@ -0,0 +1,97 @@
+import { expect } from 'chai';
+import { spec } from 'modules/adfusionBidAdapter';
+import 'modules/priceFloors.js';
+import { newBidder } from 'src/adapters/bidderFactory';
+
+describe('adfusionBidAdapter', function () {
+ const adapter = newBidder(spec);
+ describe('inherited functions', function () {
+ it('exists and is a function', function () {
+ expect(adapter.callBids).to.exist.and.to.be.a('function');
+ });
+ });
+
+ describe('isBidRequestValid', function () {
+ const bid = {
+ bidder: 'adfusion',
+ params: {
+ accountId: 1234,
+ },
+ adUnitCode: '/adunit-code/test-path',
+ bidId: 'test-bid-id-1',
+ bidderRequestId: 'test-bid-request-1',
+ auctionId: 'test-auction-1',
+ transactionId: 'test-transactionId-1',
+ };
+
+ it('should return true when required params found', function () {
+ expect(spec.isBidRequestValid(bid)).to.equal(true);
+ });
+
+ it('should return false when params.accountID is missing', function () {
+ let localbid = Object.assign({}, bid);
+ delete localbid.params.accountId;
+ expect(spec.isBidRequestValid(bid)).to.equal(false);
+ });
+ });
+
+ describe('buildRequests', function () {
+ let bidRequests, bidderRequest;
+ beforeEach(function () {
+ bidRequests = [
+ {
+ bidder: 'adfusion',
+ params: {
+ accountId: 1234,
+ },
+ mediaTypes: {
+ banner: {
+ sizes: [
+ [300, 250],
+ [300, 600],
+ ],
+ },
+ },
+ adUnitCode: '/adunit-code/test-path',
+ bidId: 'test-bid-id-1',
+ bidderRequestId: 'test-bid-request-1',
+ auctionId: 'test-auction-1',
+ transactionId: 'test-transactionId-1',
+ },
+ {
+ bidder: 'adfusion',
+ params: {
+ accountId: 1234,
+ },
+ adUnitCode: 'adunit-code',
+ mediaTypes: {
+ video: {
+ playerSize: [640, 480],
+ },
+ },
+ bidId: 'test-bid-id-2',
+ bidderRequestId: 'test-bid-request-2',
+ auctionId: 'test-auction-2',
+ transactionId: 'test-transactionId-2',
+ },
+ ];
+ bidderRequest = { refererInfo: {} };
+ });
+
+ it('should return an empty array when no bid requests', function () {
+ const bidRequest = spec.buildRequests([], bidderRequest);
+ expect(bidRequest).to.be.an('array');
+ expect(bidRequest.length).to.equal(0);
+ });
+
+ it('should return a valid bid request object', function () {
+ const request = spec.buildRequests(bidRequests, bidderRequest);
+ expect(request).to.be.an('array');
+ expect(request[0].data).to.be.an('object');
+ expect(request[0].method).to.equal('POST');
+ expect(request[0].url).to.not.equal('');
+ expect(request[0].url).to.not.equal(undefined);
+ expect(request[0].url).to.not.equal(null);
+ });
+ });
+});
diff --git a/test/spec/modules/adkernelBidAdapter_spec.js b/test/spec/modules/adkernelBidAdapter_spec.js
index 90200a801c5..ade34478c20 100644
--- a/test/spec/modules/adkernelBidAdapter_spec.js
+++ b/test/spec/modules/adkernelBidAdapter_spec.js
@@ -15,11 +15,13 @@ describe('Adkernel adapter', function () {
auctionId: 'auc-001',
mediaTypes: {
banner: {
- sizes: [[300, 250], [300, 200]]
+ sizes: [[300, 250], [300, 200]],
+ pos: 1
}
},
ortb2Imp: {
- battr: [6, 7, 9]
+ battr: [6, 7, 9],
+ pos: 2
}
}, bid2_zone2 = {
bidder: 'adkernel',
@@ -103,7 +105,11 @@ describe('Adkernel adapter', function () {
video: {
context: 'instream',
playerSize: [[640, 480]],
- api: [1, 2]
+ api: [1, 2],
+ placement: 1,
+ plcmt: 1,
+ skip: 1,
+ pos: 1
}
},
adUnitCode: 'ad-unit-1'
@@ -244,6 +250,31 @@ describe('Adkernel adapter', function () {
}],
bidid: 'pTuOlf5KHUo',
cur: 'EUR'
+ },
+ multiformat_response = {
+ id: '47ce4badcf7482',
+ seatbid: [{
+ bid: [{
+ id: 'sZSYq5zYMxo_0',
+ impid: 'Bid_01b__mf',
+ crid: '100_003',
+ price: 0.00145,
+ adid: '158801',
+ adm: '',
+ nurl: 'https://rtb.com/win?i=sZSYq5zYMxo_0&f=nurl',
+ cid: '16855'
+ }, {
+ id: 'sZSYq5zYMxo_1',
+ impid: 'Bid_01v__mf',
+ crid: '100_003',
+ price: 0.25,
+ adid: '158801',
+ nurl: 'https://rtb.com/win?i=sZSYq5zYMxo_1&f=nurl',
+ cid: '16855'
+ }]
+ }],
+ bidid: 'pTuOlf5KHUo',
+ cur: 'USD'
};
var sandbox;
@@ -346,6 +377,11 @@ describe('Adkernel adapter', function () {
expect(bidRequest.imp[0].banner.battr).to.be.eql([6, 7, 9]);
});
+ it('should respect mediatypes attributes over FPD', function() {
+ expect(bidRequest.imp[0].banner).to.have.property('pos');
+ expect(bidRequest.imp[0].banner.pos).to.be.eql(1);
+ });
+
it('shouldn\'t contain gdpr nor ccpa information for default request', function () {
let [_, bidRequests] = buildRequest([bid1_zone1]);
expect(bidRequests[0]).to.not.have.property('regs');
@@ -438,24 +474,40 @@ describe('Adkernel adapter', function () {
});
it('should have openrtb video impression parameters', function() {
- expect(bidRequests[0].imp[0].video).to.have.property('api');
- expect(bidRequests[0].imp[0].video.api).to.be.eql([1, 2]);
+ let video = bidRequests[0].imp[0].video;
+ expect(video).to.have.property('api');
+ expect(video.api).to.be.eql([1, 2]);
+ expect(video.placement).to.be.eql(1);
+ expect(video.plcmt).to.be.eql(1);
+ expect(video.skip).to.be.eql(1);
+ expect(video.pos).to.be.eql(1);
});
});
describe('multiformat request building', function () {
- let _, bidRequests;
+ let pbRequests, bidRequests;
before(function () {
- [_, bidRequests] = buildRequest([bid_multiformat]);
+ [pbRequests, bidRequests] = buildRequest([bid_multiformat]);
});
it('should contain single request', function () {
expect(bidRequests).to.have.length(1);
- expect(bidRequests[0].imp).to.have.length(1);
});
- it('should contain banner-only impression', function () {
- expect(bidRequests[0].imp).to.have.length(1);
+ it('should contain both impression', function () {
+ expect(bidRequests[0].imp).to.have.length(2);
expect(bidRequests[0].imp[0]).to.have.property('banner');
- expect(bidRequests[0].imp[0]).to.not.have.property('video');
+ expect(bidRequests[0].imp[1]).to.have.property('video');
+ // check that splitted imps do not share same impid
+ expect(bidRequests[0].imp[0].id).to.be.not.eql('Bid_01');
+ expect(bidRequests[0].imp[1].id).to.be.not.eql('Bid_01');
+ expect(bidRequests[0].imp[1].id).to.be.not.eql(bidRequests[0].imp[0].id);
+ });
+ it('x', function() {
+ let bids = spec.interpretResponse({body: multiformat_response}, pbRequests[0]);
+ expect(bids).to.have.length(2);
+ expect(bids[0].requestId).to.be.eql('Bid_01');
+ expect(bids[0].mediaType).to.be.eql('banner');
+ expect(bids[1].requestId).to.be.eql('Bid_01');
+ expect(bids[1].mediaType).to.be.eql('video');
});
});
diff --git a/test/spec/modules/admaticBidAdapter_spec.js b/test/spec/modules/admaticBidAdapter_spec.js
index 8c9969e4d46..b4d84634962 100644
--- a/test/spec/modules/admaticBidAdapter_spec.js
+++ b/test/spec/modules/admaticBidAdapter_spec.js
@@ -1,12 +1,553 @@
-import {expect} from 'chai';
-import {spec, storage} from 'modules/admaticBidAdapter.js';
-import {newBidder} from 'src/adapters/bidderFactory.js';
-import {getStorageManager} from 'src/storageManager';
+import { expect } from 'chai';
+import { spec } from 'modules/admaticBidAdapter.js';
+import { newBidder } from 'src/adapters/bidderFactory.js';
+import { config } from 'src/config.js';
const ENDPOINT = 'https://layer.serve.admatic.com.tr/pb';
describe('admaticBidAdapter', () => {
const adapter = newBidder(spec);
+ let validRequest = [ {
+ 'refererInfo': {
+ 'page': 'https://www.admatic.com.tr',
+ 'domain': 'https://www.admatic.com.tr',
+ },
+ 'bidder': 'admatic',
+ 'params': {
+ 'networkId': 10433394,
+ 'host': 'layer.serve.admatic.com.tr'
+ },
+ 'ortb2Imp': { 'ext': { 'instl': 1 } },
+ 'ortb2': { 'badv': ['admatic.com.tr'] },
+ 'mediaTypes': {
+ 'banner': {
+ 'sizes': [[300, 250], [728, 90]]
+ },
+ 'native': {
+ },
+ 'video': {
+ }
+ },
+ getFloor: inputParams => {
+ if (inputParams.mediaType === BANNER && inputParams.size[0] === 300 && inputParams.size[1] === 250) {
+ return {
+ currency: 'USD',
+ floor: 1.0
+ };
+ } else if (inputParams.mediaType === BANNER && inputParams.size[0] === 728 && inputParams.size[1] === 90) {
+ return {
+ currency: 'USD',
+ floor: 2.0
+ };
+ } else if (inputParams.mediaType === VIDEO) {
+ return {
+ currency: 'USD',
+ floor: 1.0
+ };
+ } else if (inputParams.mediaType === NATIVE) {
+ return {
+ currency: 'USD',
+ floor: 1.0
+ };
+ } else {
+ return {}
+ }
+ },
+ 'schain': {
+ 'ver': '1.0',
+ 'complete': 1,
+ 'nodes': [
+ {
+ 'asi': 'pixad.com.tr',
+ 'sid': 'px-pub-3000856707',
+ 'hp': 1
+ }
+ ]
+ },
+ 'at': 1,
+ 'tmax': 1000,
+ 'user': {
+ 'ext': {
+ 'eids': [
+ {
+ 'source': 'id5-sync.com',
+ 'uids': [
+ {
+ 'id': '0',
+ 'atype': 1,
+ 'ext': {
+ 'linkType': 0,
+ 'pba': 'wMh3sAXcnhDq7CfSa6ji1g=='
+ }
+ }
+ ]
+ },
+ {
+ 'source': 'pubcid.org',
+ 'uids': [
+ {
+ 'id': '5a49273f-a424-454b-b478-169c3551aa72',
+ 'atype': 1
+ }
+ ]
+ }
+ ]
+ }
+ },
+ 'ortb': {
+ 'badv': [],
+ 'bcat': [],
+ 'site': {
+ 'page': 'http://localhost:8888/admatic.html',
+ 'ref': 'http://localhost:8888',
+ 'publisher': {
+ 'name': 'localhost'
+ }
+ },
+ 'device': {
+ 'ua': 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/119.0.0.0 Safari/537.36'
+ }
+ },
+ 'site': {
+ 'page': 'http://localhost:8888/admatic.html',
+ 'ref': 'http://localhost:8888',
+ 'publisher': {
+ 'name': 'localhost',
+ 'publisherId': 12321312
+ }
+ },
+ 'imp': [
+ {
+ 'size': [
+ {
+ 'w': 300,
+ 'h': 250
+ },
+ {
+ 'w': 728,
+ 'h': 90
+ }
+ ],
+ 'mediatype': {},
+ 'type': 'banner',
+ 'id': '2205da7a81846b',
+ 'floors': {
+ 'banner': {
+ '300x250': { 'currency': 'USD', 'floor': 1 },
+ '728x90': { 'currency': 'USD', 'floor': 2 }
+ }
+ }
+ },
+ {
+ 'size': [
+ {
+ 'w': 338,
+ 'h': 280
+ }
+ ],
+ 'type': 'video',
+ 'mediatype': {
+ 'context': 'instream',
+ 'mimes': [
+ 'video/mp4'
+ ],
+ 'maxduration': 240,
+ 'api': [
+ 1,
+ 2
+ ],
+ 'playerSize': [
+ [
+ 338,
+ 280
+ ]
+ ],
+ 'protocols': [
+ 1,
+ 2,
+ 3,
+ 4,
+ 5,
+ 6,
+ 7,
+ 8
+ ],
+ 'skip': 1,
+ 'playbackmethod': [
+ 2
+ ],
+ 'linearity': 1,
+ 'placement': 2
+ },
+ 'floors': {
+ 'video': {
+ '338x280': { 'currency': 'USD', 'floor': 1 }
+ }
+ },
+ 'id': '45e86fc7ce7fc93'
+ },
+ {
+ 'size': [
+ {
+ 'w': 1,
+ 'h': 1
+ }
+ ],
+ 'type': 'native',
+ 'mediatype': {
+ 'title': {
+ 'required': true,
+ 'len': 120
+ },
+ 'image': {
+ 'required': true
+ },
+ 'icon': {
+ 'required': false,
+ 'sizes': [
+ 640,
+ 480
+ ]
+ },
+ 'sponsoredBy': {
+ 'required': false
+ },
+ 'body': {
+ 'required': false
+ },
+ 'clickUrl': {
+ 'required': false
+ },
+ 'displayUrl': {
+ 'required': false
+ }
+ },
+ 'ext': {
+ 'instl': 0,
+ 'gpid': 'native-INS_b1b1269f-9570-fe3c-9bf4-f187827ec94a',
+ 'data': {
+ 'pbadslot': 'native-INS_b1b1269f-9570-fe3c-9bf4-f187827ec94a'
+ }
+ },
+ 'floors': {
+ 'native': {
+ '*': { 'currency': 'USD', 'floor': 1 }
+ }
+ },
+ 'id': '16e0c8982318f91'
+ }
+ ],
+ 'ext': {
+ 'cur': 'USD',
+ 'bidder': 'admatic'
+ }
+ } ];
+ let bidderRequest = {
+ 'refererInfo': {
+ 'page': 'https://www.admatic.com.tr',
+ 'domain': 'https://www.admatic.com.tr',
+ },
+ 'bidder': 'admatic',
+ 'params': {
+ 'networkId': 10433394,
+ 'host': 'layer.serve.admatic.com.tr'
+ },
+ 'ortb2Imp': { 'ext': { 'instl': 1 } },
+ 'ortb2': { 'badv': ['admatic.com.tr'] },
+ 'mediaTypes': {
+ 'banner': {
+ 'sizes': [[300, 250], [728, 90]]
+ },
+ 'native': {
+ },
+ 'video': {
+ 'playerSize': [
+ 336,
+ 280
+ ]
+ }
+ },
+ 'userId': {
+ 'id5id': {
+ 'uid': '0',
+ 'ext': {
+ 'linkType': 0,
+ 'pba': 'wMh3sAXcnhDq7CfSa6ji1g=='
+ }
+ },
+ 'pubcid': '5a49273f-a424-454b-b478-169c3551aa72'
+ },
+ 'userIdAsEids': [
+ {
+ 'source': 'id5-sync.com',
+ 'uids': [
+ {
+ 'id': '0',
+ 'atype': 1,
+ 'ext': {
+ 'linkType': 0,
+ 'pba': 'wMh3sAXcnhDq7CfSa6ji1g=='
+ }
+ }
+ ]
+ },
+ {
+ 'source': 'pubcid.org',
+ 'uids': [
+ {
+ 'id': '5a49273f-a424-454b-b478-169c3551aa72',
+ 'atype': 1
+ }
+ ]
+ }
+ ],
+ getFloor: inputParams => {
+ if (inputParams.mediaType === BANNER && inputParams.size[0] === 300 && inputParams.size[1] === 250) {
+ return {
+ currency: 'USD',
+ floor: 1.0
+ };
+ } else if (inputParams.mediaType === BANNER && inputParams.size[0] === 728 && inputParams.size[1] === 90) {
+ return {
+ currency: 'USD',
+ floor: 2.0
+ };
+ } else if (inputParams.mediaType === VIDEO) {
+ return {
+ currency: 'USD',
+ floor: 1.0
+ };
+ } else if (inputParams.mediaType === NATIVE) {
+ return {
+ currency: 'USD',
+ floor: 1.0
+ };
+ } else {
+ return {}
+ }
+ },
+ 'schain': {
+ 'ver': '1.0',
+ 'complete': 1,
+ 'nodes': [
+ {
+ 'asi': 'pixad.com.tr',
+ 'sid': 'px-pub-3000856707',
+ 'hp': 1
+ }
+ ]
+ },
+ 'at': 1,
+ 'tmax': 1000,
+ 'user': {
+ 'ext': {
+ 'eids': [
+ {
+ 'source': 'id5-sync.com',
+ 'uids': [
+ {
+ 'id': '0',
+ 'atype': 1,
+ 'ext': {
+ 'linkType': 0,
+ 'pba': 'wMh3sAXcnhDq7CfSa6ji1g=='
+ }
+ }
+ ]
+ },
+ {
+ 'source': 'pubcid.org',
+ 'uids': [
+ {
+ 'id': '5a49273f-a424-454b-b478-169c3551aa72',
+ 'atype': 1
+ }
+ ]
+ }
+ ]
+ }
+ },
+ 'ortb': {
+ 'source': {},
+ 'site': {
+ 'domain': 'localhost:8888',
+ 'publisher': {
+ 'domain': 'localhost:8888'
+ },
+ 'page': 'http://localhost:8888/',
+ 'name': 'http://localhost:8888'
+ },
+ 'badv': [],
+ 'bcat': [],
+ 'device': {
+ 'w': 896,
+ 'h': 979,
+ 'dnt': 0,
+ 'ua': 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/119.0.0.0 Safari/537.36',
+ 'language': 'tr',
+ 'sua': {
+ 'source': 1,
+ 'platform': {
+ 'brand': 'macOS'
+ },
+ 'browsers': [
+ {
+ 'brand': 'Google Chrome',
+ 'version': [
+ '119'
+ ]
+ },
+ {
+ 'brand': 'Chromium',
+ 'version': [
+ '119'
+ ]
+ },
+ {
+ 'brand': 'Not?A_Brand',
+ 'version': [
+ '24'
+ ]
+ }
+ ],
+ 'mobile': 0
+ }
+ }
+ },
+ 'site': {
+ 'page': 'http://localhost:8888/admatic.html',
+ 'ref': 'http://localhost:8888',
+ 'publisher': {
+ 'name': 'localhost',
+ 'publisherId': 12321312
+ }
+ },
+ 'imp': [
+ {
+ 'size': [
+ {
+ 'w': 300,
+ 'h': 250
+ },
+ {
+ 'w': 728,
+ 'h': 90
+ }
+ ],
+ 'id': '2205da7a81846b',
+ 'mediatype': {},
+ 'type': 'banner',
+ 'floors': {
+ 'banner': {
+ '300x250': { 'currency': 'USD', 'floor': 1 },
+ '728x90': { 'currency': 'USD', 'floor': 2 }
+ }
+ }
+ },
+ {
+ 'size': [
+ {
+ 'w': 338,
+ 'h': 280
+ }
+ ],
+ 'type': 'video',
+ 'mediatype': {
+ 'context': 'instream',
+ 'mimes': [
+ 'video/mp4'
+ ],
+ 'maxduration': 240,
+ 'api': [
+ 1,
+ 2
+ ],
+ 'playerSize': [
+ [
+ 338,
+ 280
+ ]
+ ],
+ 'protocols': [
+ 1,
+ 2,
+ 3,
+ 4,
+ 5,
+ 6,
+ 7,
+ 8
+ ],
+ 'skip': 1,
+ 'playbackmethod': [
+ 2
+ ],
+ 'linearity': 1,
+ 'placement': 2
+ },
+ 'floors': {
+ 'video': {
+ '338x280': { 'currency': 'USD', 'floor': 1 }
+ }
+ },
+ 'id': '45e86fc7ce7fc93'
+ },
+ {
+ 'size': [
+ {
+ 'w': 1,
+ 'h': 1
+ }
+ ],
+ 'type': 'native',
+ 'mediatype': {
+ 'title': {
+ 'required': true,
+ 'len': 120
+ },
+ 'image': {
+ 'required': true
+ },
+ 'icon': {
+ 'required': false,
+ 'sizes': [
+ 640,
+ 480
+ ]
+ },
+ 'sponsoredBy': {
+ 'required': false
+ },
+ 'body': {
+ 'required': false
+ },
+ 'clickUrl': {
+ 'required': false
+ },
+ 'displayUrl': {
+ 'required': false
+ }
+ },
+ 'ext': {
+ 'instl': 0,
+ 'gpid': 'native-INS_b1b1269f-9570-fe3c-9bf4-f187827ec94a',
+ 'data': {
+ 'pbadslot': 'native-INS_b1b1269f-9570-fe3c-9bf4-f187827ec94a'
+ }
+ },
+ 'floors': {
+ 'native': {
+ '*': { 'currency': 'USD', 'floor': 1 }
+ }
+ },
+ 'id': '16e0c8982318f91'
+ }
+ ],
+ 'ext': {
+ 'cur': 'USD',
+ 'bidder': 'admatic'
+ }
+ };
describe('inherited functions', () => {
it('exists and is a function', () => {
@@ -16,6 +557,10 @@ describe('admaticBidAdapter', () => {
describe('isBidRequestValid', function() {
let bid = {
+ 'refererInfo': {
+ 'page': 'https://www.admatic.com.tr',
+ 'domain': 'https://www.admatic.com.tr',
+ },
'bidder': 'admatic',
'params': {
'networkId': 10433394,
@@ -47,255 +592,147 @@ describe('admaticBidAdapter', () => {
describe('buildRequests', function () {
it('sends bid request to ENDPOINT via POST', function () {
- let validRequest = [ {
- 'bidder': 'admatic',
- 'params': {
- 'networkId': 10433394,
- 'host': 'layer.serve.admatic.com.tr'
- },
- 'ortb2Imp': { 'ext': { 'instl': 1 } },
- 'ortb2': { 'badv': ['admatic.com.tr'] },
- 'mediaTypes': {
- 'banner': {
- 'sizes': [[300, 250], [728, 90]]
- }
- },
- getFloor: inputParams => {
- if (inputParams.mediaType === BANNER && inputParams.size[0] === 300 && inputParams.size[1] === 250) {
- return {
- currency: 'USD',
- floor: 1.0
- };
- } else if (inputParams.mediaType === BANNER && inputParams.size[0] === 728 && inputParams.size[1] === 90) {
- return {
- currency: 'USD',
- floor: 2.0
- };
- } else {
- return {}
- }
- },
- 'user': {
- 'ua': 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/107.0.0.0 Safari/537.36'
- },
- 'blacklist': [],
- 'site': {
- 'page': 'http://localhost:8888/admatic.html',
- 'ref': 'http://localhost:8888',
- 'publisher': {
- 'name': 'localhost',
- 'publisherId': 12321312
+ const request = spec.buildRequests(validRequest, bidderRequest);
+ expect(request.url).to.equal(ENDPOINT);
+ expect(request.method).to.equal('POST');
+ });
+
+ it('should not populate GDPR if for non-EEA users', function () {
+ let bidRequest = Object.assign([], validRequest);
+ const request = spec.buildRequests(
+ bidRequest,
+ Object.assign({}, bidderRequest, {
+ gdprConsent: {
+ gdprApplies: true,
+ consentString: 'BOJ8RZsOJ8RZsABAB8AAAAAZ+A=='
}
- },
- 'imp': [
- {
- 'size': [
- {
- 'w': 300,
- 'h': 250
- },
- {
- 'w': 728,
- 'h': 90
- }
- ],
- 'mediatype': {},
- 'type': 'banner',
- 'id': '2205da7a81846b',
- 'floors': {
- 'banner': {
- '300x250': { 'currency': 'USD', 'floor': 1 },
- '728x90': { 'currency': 'USD', 'floor': 2 }
- }
- }
- },
- {
- 'size': [
- {
- 'w': 338,
- 'h': 280
- }
- ],
- 'type': 'video',
- 'mediatype': {
- 'context': 'instream',
- 'mimes': [
- 'video/mp4'
- ],
- 'maxduration': 240,
- 'api': [
- 1,
- 2
- ],
- 'playerSize': [
- [
- 338,
- 280
- ]
- ],
- 'protocols': [
- 1,
- 2,
- 3,
- 4,
- 5,
- 6,
- 7,
- 8
- ],
- 'skip': 1,
- 'playbackmethod': [
- 2
- ],
- 'linearity': 1,
- 'placement': 2
- },
- 'id': '45e86fc7ce7fc93'
+ })
+ );
+ expect(request.data.regs.ext.gdpr).to.equal(1);
+ expect(request.data.regs.ext.consent).to.equal('BOJ8RZsOJ8RZsABAB8AAAAAZ-A');
+ });
+
+ it('should populate GDPR and empty consent string if available for EEA users without consent string but with consent', function () {
+ let bidRequest = Object.assign([], validRequest);
+ const request = spec.buildRequests(
+ bidRequest,
+ Object.assign({}, bidderRequest, {
+ gdprConsent: {
+ gdprApplies: true
}
- ],
- 'ext': {
- 'cur': 'USD',
- 'bidder': 'admatic'
+ })
+ );
+ expect(request.data.regs.ext.gdpr).to.equal(1);
+ expect(request.data.regs.ext.consent).to.equal('');
+ });
+
+ it('should properly build a request when coppa flag is true', function () {
+ let bidRequest = Object.assign([], validRequest);
+ const request = spec.buildRequests(
+ bidRequest,
+ Object.assign({}, bidderRequest, {
+ coppa: true
+ })
+ );
+ expect(request.data.regs.ext.coppa).to.not.be.undefined;
+ expect(request.data.regs.ext.coppa).to.equal(1);
+ });
+
+ it('should properly build a request with gpp consent field', function () {
+ let bidRequest = Object.assign([], validRequest);
+ const ortb2 = {
+ regs: {
+ gpp: 'gpp_consent_string',
+ gpp_sid: [0, 1, 2]
}
- } ];
- let bidderRequest = {
- 'bidder': 'admatic',
- 'params': {
- 'networkId': 10433394,
- 'host': 'layer.serve.admatic.com.tr'
- },
- 'ortb2Imp': { 'ext': { 'instl': 1 } },
- 'ortb2': { 'badv': ['admatic.com.tr'] },
- 'mediaTypes': {
- 'banner': {
- 'sizes': [[300, 250], [728, 90]]
- }
- },
- getFloor: inputParams => {
- if (inputParams.mediaType === BANNER && inputParams.size[0] === 300 && inputParams.size[1] === 250) {
- return {
- currency: 'USD',
- floor: 1.0
- };
- } else if (inputParams.mediaType === BANNER && inputParams.size[0] === 728 && inputParams.size[1] === 90) {
- return {
- currency: 'USD',
- floor: 2.0
- };
- } else {
- return {}
- }
- },
- 'user': {
- 'ua': 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/107.0.0.0 Safari/537.36'
- },
- 'blacklist': [],
- 'site': {
- 'page': 'http://localhost:8888/admatic.html',
- 'ref': 'http://localhost:8888',
- 'publisher': {
- 'name': 'localhost',
- 'publisherId': 12321312
- }
- },
- 'imp': [
- {
- 'size': [
- {
- 'w': 300,
- 'h': 250
- },
- {
- 'w': 728,
- 'h': 90
- }
- ],
- 'id': '2205da7a81846b',
- 'mediatype': {},
- 'type': 'banner',
- 'floors': {
- 'banner': {
- '300x250': { 'currency': 'USD', 'floor': 1 },
- '728x90': { 'currency': 'USD', 'floor': 2 }
- }
+ };
+ const request = spec.buildRequests(bidRequest, { ...bidderRequest, ortb2 });
+ expect(request.data.regs.ext.gpp).to.equal('gpp_consent_string');
+ expect(request.data.regs.ext.gpp_sid).to.deep.equal([0, 1, 2]);
+ });
+
+ it('should properly build a request with ccpa consent field', function () {
+ let bidRequest = Object.assign([], validRequest);
+ const request = spec.buildRequests(
+ bidRequest,
+ Object.assign({}, bidderRequest, {
+ uspConsent: '1---'
+ })
+ );
+ expect(request.data.regs.ext.uspIab).to.not.be.null;
+ expect(request.data.regs.ext.uspIab).to.equal('1---');
+ });
+
+ it('should properly forward eids', function () {
+ const bidRequests = [
+ {
+ bidder: 'admatic',
+ adUnitCode: 'bid-123',
+ transactionId: 'transaction-123',
+ mediaTypes: {
+ banner: {
+ sizes: [[728, 90]]
}
},
- {
- 'size': [
- {
- 'w': 338,
- 'h': 280
- }
- ],
- 'type': 'video',
- 'mediatype': {
- 'context': 'instream',
- 'mimes': [
- 'video/mp4'
- ],
- 'maxduration': 240,
- 'api': [
- 1,
- 2
- ],
- 'playerSize': [
- [
- 338,
- 280
- ]
- ],
- 'protocols': [
- 1,
- 2,
- 3,
- 4,
- 5,
- 6,
- 7,
- 8
- ],
- 'skip': 1,
- 'playbackmethod': [
- 2
- ],
- 'linearity': 1,
- 'placement': 2
- },
- 'id': '45e86fc7ce7fc93'
- }
- ],
- 'ext': {
- 'cur': 'USD',
- 'bidder': 'admatic'
+ userIdAsEids: [
+ {
+ source: 'admatic.com.tr',
+ uids: [{
+ id: 'abc',
+ atype: 1
+ }]
+ }
+ ],
+ params: {}
+ },
+ ];
+ const request = spec.buildRequests(bidRequests, bidderRequest);
+ const ortbRequest = request.data;
+ expect(ortbRequest.user.ext.eids).to.deep.equal([
+ {
+ source: 'admatic.com.tr',
+ uids: [{
+ id: 'abc',
+ atype: 1
+ }]
}
- };
- const request = spec.buildRequests(validRequest, bidderRequest);
- expect(request.url).to.equal(ENDPOINT);
- expect(request.method).to.equal('POST');
+ ]);
});
it('should properly build a banner request with floors', function () {
- let bidRequests = [
+ const request = spec.buildRequests(validRequest, bidderRequest);
+ request.data.imp[0].floors = {
+ 'banner': {
+ '300x250': { 'currency': 'USD', 'floor': 1 },
+ '728x90': { 'currency': 'USD', 'floor': 2 }
+ }
+ };
+ });
+
+ it('should properly build a video request with several player sizes with floors', function () {
+ const bidRequests = [
{
'bidder': 'admatic',
- 'params': {
- 'networkId': 10433394,
- 'host': 'layer.serve.admatic.com.tr'
- },
+ 'adUnitCode': 'bid-123',
+ 'transactionId': 'transaction-123',
'mediaTypes': {
- 'banner': {
- 'sizes': [[300, 250], [728, 90]]
+ 'video': {
+ 'playerSize': [[300, 250], [728, 90]]
}
},
'ortb2Imp': { 'ext': { 'instl': 1 } },
'ortb2': { 'badv': ['admatic.com.tr'] },
+ 'params': {
+ 'networkId': 10433394,
+ 'host': 'layer.serve.admatic.com.tr'
+ },
getFloor: inputParams => {
- if (inputParams.mediaType === BANNER && inputParams.size[0] === 300 && inputParams.size[1] === 250) {
+ if (inputParams.mediaType === VIDEO && inputParams.size[0] === 300 && inputParams.size[1] === 250) {
return {
currency: 'USD',
floor: 1.0
};
- } else if (inputParams.mediaType === BANNER && inputParams.size[0] === 728 && inputParams.size[1] === 90) {
+ } else if (inputParams.mediaType === VIDEO && inputParams.size[0] === 728 && inputParams.size[1] === 90) {
return {
currency: 'USD',
floor: 2.0
@@ -306,33 +743,50 @@ describe('admaticBidAdapter', () => {
}
},
];
- let bidderRequest = {
- 'bidder': 'admatic',
- 'params': {
- 'networkId': 10433394,
- 'host': 'layer.serve.admatic.com.tr'
- },
- 'ortb2Imp': { 'ext': { 'instl': 1 } },
- 'ortb2': { 'badv': ['admatic.com.tr'] },
- 'adUnitCode': 'adunit-code',
- 'sizes': [[300, 250], [728, 90]],
- 'bidId': '30b31c1838de1e',
- 'bidderRequestId': '22edbae2733bf6',
- 'auctionId': '1d1a030790a475',
- 'creativeId': 'er2ee',
- 'mediaTypes': {
- 'banner': {
- 'sizes': [[300, 250], [728, 90]]
- }
+ const bidderRequest = {
+ 'refererInfo': {
+ 'page': 'https://www.admatic.com.tr',
+ 'domain': 'https://www.admatic.com.tr',
}
};
const request = spec.buildRequests(bidRequests, bidderRequest);
- request.data.imp[0].floors = {
- 'banner': {
- '300x250': { 'currency': 'USD', 'floor': 1 },
- '728x90': { 'currency': 'USD', 'floor': 2 }
+ });
+
+ it('should properly build a native request with floors', function () {
+ const bidRequests = [
+ {
+ 'bidder': 'admatic',
+ 'adUnitCode': 'bid-123',
+ 'transactionId': 'transaction-123',
+ 'mediaTypes': {
+ 'native': {
+ }
+ },
+ 'ortb2Imp': { 'ext': { 'instl': 1 } },
+ 'ortb2': { 'badv': ['admatic.com.tr'] },
+ 'params': {
+ 'networkId': 10433394,
+ 'host': 'layer.serve.admatic.com.tr'
+ },
+ getFloor: inputParams => {
+ if (inputParams.mediaType === NATIVE) {
+ return {
+ currency: 'USD',
+ floor: 1.0
+ };
+ } else {
+ return {}
+ }
+ }
+ },
+ ];
+ const bidderRequest = {
+ 'refererInfo': {
+ 'page': 'https://www.admatic.com.tr',
+ 'domain': 'https://www.admatic.com.tr',
}
};
+ const request = spec.buildRequests(bidRequests, bidderRequest);
});
});
@@ -348,6 +802,7 @@ describe('admaticBidAdapter', () => {
'price': 0.01,
'type': 'banner',
'bidder': 'admatic',
+ 'mime_type': 'iframe',
'adomain': ['admatic.com.tr'],
'party_tag': '',
'iurl': 'https://www.admatic.com.tr'
@@ -359,6 +814,7 @@ describe('admaticBidAdapter', () => {
'height': 250,
'price': 0.01,
'type': 'video',
+ 'mime_type': 'iframe',
'bidder': 'admatic',
'adomain': ['admatic.com.tr'],
'party_tag': 'test response
',
+ 'cpm': 5250,
+ 'creativeId': '5_1234ABCD',
+ 'currency': 'JPY',
+ 'height': 250,
+ 'meta': {
+ 'advertiserDomains': [
+ 'adv.example'
+ ],
+ 'mediaType': 'banner',
+ 'networkId': 5
+ },
+ 'netRevenue': true,
+ 'requestId': '22a9457aed98a4',
+ 'transactionId': 'f18c078e-4d2a-4ecb-a886-2a0c52187213',
+ 'ttl': 60,
+ 'width': 300,
+ }
+ }
+ ]
+ },
+ 'headers': {}
+ };
+ const bids = spec.interpretResponse(serverResponse);
+ expect(bids[0]).to.deep.equal(serverResponse.body.seatbid[0].bid);
+ });
+ });
+});
diff --git a/test/spec/modules/adtelligentBidAdapter_spec.js b/test/spec/modules/adtelligentBidAdapter_spec.js
index e40828e6852..0acbaa06f5b 100644
--- a/test/spec/modules/adtelligentBidAdapter_spec.js
+++ b/test/spec/modules/adtelligentBidAdapter_spec.js
@@ -11,18 +11,13 @@ const EXPECTED_ENDPOINTS = [
'https://ghb.adtelligent.com/v2/auction/'
];
const aliasEP = {
- 'appaloosa': 'https://ghb.hb.appaloosa.media/v2/auction/',
- 'appaloosa_publisherSuffix': 'https://ghb.hb.appaloosa.media/v2/auction/',
- 'onefiftytwomedia': 'https://ghb.ads.152media.com/v2/auction/',
- 'navelix': 'https://ghb.hb.navelix.com/v2/auction/',
- 'bidsxchange': 'https://ghb.hbd.bidsxchange.com/v2/auction/',
+ 'janet_publisherSuffix': 'https://ghb.bidder.jmgads.com/v2/auction/',
'streamkey': 'https://ghb.hb.streamkey.net/v2/auction/',
'janet': 'https://ghb.bidder.jmgads.com/v2/auction/',
- 'pgam': 'https://ghb.pgamssp.com/v2/auction/',
'ocm': 'https://ghb.cenarius.orangeclickmedia.com/v2/auction/',
- 'vidcrunchllc': 'https://ghb.platform.vidcrunch.com/v2/auction/',
'9dotsmedia': 'https://ghb.platform.audiodots.com/v2/auction/',
'copper6': 'https://ghb.app.copper6.com/v2/auction/',
+ 'indicue': 'https://ghb.console.indicue.com/v2/auction/',
};
const DEFAULT_ADATPER_REQ = { bidderCode: 'adtelligent' };
diff --git a/test/spec/modules/adxcgBidAdapter_spec.js b/test/spec/modules/adxcgBidAdapter_spec.js
index 65c7584b428..e07e3a6e5d4 100644
--- a/test/spec/modules/adxcgBidAdapter_spec.js
+++ b/test/spec/modules/adxcgBidAdapter_spec.js
@@ -1,835 +1,19 @@
// jshint esversion: 6, es3: false, node: true
-import {assert} from 'chai';
-import {spec} from 'modules/adxcgBidAdapter.js';
-import {config} from 'src/config.js';
-import {createEidsArray} from 'modules/userId/eids.js';
+import { assert } from 'chai';
+import { spec } from 'modules/adxcgBidAdapter.js';
+import { config } from 'src/config.js';
+import { createEidsArray } from 'modules/userId/eids.js';
+/* eslint dot-notation:0, quote-props:0 */
+import { expect } from 'chai';
+
+import { syncAddFPDToBidderRequest } from '../../helpers/fpd.js';
+import { deepClone } from '../../../src/utils';
+
const utils = require('src/utils');
describe('Adxcg adapter', function () {
let bids = [];
- describe('isBidRequestValid', function () {
- let bid = {
- 'bidder': 'adxcg',
- 'params': {
- 'adzoneid': '19910113'
- }
- };
-
- it('should return true when required params found', function () {
- assert(spec.isBidRequestValid(bid));
-
- bid.params = {
- adzoneid: 4332,
- };
- assert(spec.isBidRequestValid(bid));
- });
-
- it('should return false when required params are missing', function () {
- bid.params = {};
- assert.isFalse(spec.isBidRequestValid(bid));
-
- bid.params = {
- mname: 'some-placement'
- };
- assert.isFalse(spec.isBidRequestValid(bid));
-
- bid.params = {
- inv: 1234
- };
- assert.isFalse(spec.isBidRequestValid(bid));
- });
- });
-
- describe('buildRequests', function () {
- beforeEach(function () {
- config.resetConfig();
- });
- it('should send request with correct structure', function () {
- let validBidRequests = [{
- bidId: 'bidId',
- params: {
- adzoneid: '19910113'
- }
- }];
- let request = spec.buildRequests(validBidRequests, {refererInfo: {page: 'page', domain: 'localhost'}});
-
- assert.equal(request.method, 'POST');
- assert.equal(request.url, 'https://pbc.adxcg.net/rtb/ortb/pbc?adExchangeId=1');
- assert.deepEqual(request.options, {contentType: 'application/json'});
- assert.ok(request.data);
- });
-
- describe('user privacy', function () {
- it('should send GDPR Consent data to exchange if gdprApplies', function () {
- let validBidRequests = [{bidId: 'bidId', params: {test: 1}}];
- let bidderRequest = {
- gdprConsent: {gdprApplies: true, consentString: 'consentDataString'},
- refererInfo: {referer: 'page'}
- };
- let request = JSON.parse(spec.buildRequests(validBidRequests, bidderRequest).data);
-
- assert.equal(request.user.ext.consent, bidderRequest.gdprConsent.consentString);
- assert.equal(request.regs.ext.gdpr, bidderRequest.gdprConsent.gdprApplies);
- assert.equal(typeof request.regs.ext.gdpr, 'number');
- });
-
- it('should send gdpr as number', function () {
- let validBidRequests = [{bidId: 'bidId', params: {test: 1}}];
- let bidderRequest = {
- gdprConsent: {gdprApplies: true, consentString: 'consentDataString'},
- refererInfo: {referer: 'page'}
- };
- let request = JSON.parse(spec.buildRequests(validBidRequests, bidderRequest).data);
-
- assert.equal(typeof request.regs.ext.gdpr, 'number');
- assert.equal(request.regs.ext.gdpr, 1);
- });
-
- it('should send CCPA Consent data to exchange', function () {
- let validBidRequests = [{bidId: 'bidId', params: {test: 1}}];
- let bidderRequest = {uspConsent: '1YA-', refererInfo: {referer: 'page'}};
- let request = JSON.parse(spec.buildRequests(validBidRequests, bidderRequest).data);
-
- assert.equal(request.regs.ext.us_privacy, '1YA-');
-
- bidderRequest = {
- uspConsent: '1YA-',
- gdprConsent: {gdprApplies: true, consentString: 'consentDataString'},
- refererInfo: {referer: 'page'}
- };
- request = JSON.parse(spec.buildRequests(validBidRequests, bidderRequest).data);
-
- assert.equal(request.regs.ext.us_privacy, '1YA-');
- assert.equal(request.user.ext.consent, 'consentDataString');
- assert.equal(request.regs.ext.gdpr, 1);
- });
-
- it('should not send GDPR Consent data to adxcg if gdprApplies is undefined', function () {
- let validBidRequests = [{
- bidId: 'bidId',
- params: {siteId: 'siteId'}
- }];
- let bidderRequest = {
- gdprConsent: {gdprApplies: false, consentString: 'consentDataString'},
- refererInfo: {referer: 'page'}
- };
- let request = JSON.parse(spec.buildRequests(validBidRequests, bidderRequest).data);
-
- assert.equal(request.user.ext.consent, 'consentDataString');
- assert.equal(request.regs.ext.gdpr, 0);
-
- bidderRequest = {gdprConsent: {consentString: 'consentDataString'}, refererInfo: {referer: 'page'}};
- request = JSON.parse(spec.buildRequests(validBidRequests, bidderRequest).data);
-
- assert.equal(request.user, undefined);
- assert.equal(request.regs, undefined);
- });
- it('should send default GDPR Consent data to exchange', function () {
- let validBidRequests = [{
- bidId: 'bidId',
- params: {siteId: 'siteId'}
- }];
- let request = JSON.parse(spec.buildRequests(validBidRequests, {refererInfo: {referer: 'page'}}).data);
-
- assert.equal(request.user, undefined);
- assert.equal(request.regs, undefined);
- });
- });
-
- it('should add test and is_debug to request, if test is set in parameters', function () {
- let validBidRequests = [{
- bidId: 'bidId',
- params: {test: 1}
- }];
- let request = JSON.parse(spec.buildRequests(validBidRequests, {refererInfo: {referer: 'page'}}).data);
-
- assert.ok(request.is_debug);
- assert.equal(request.test, 1);
- });
-
- it('should have default request structure', function () {
- let keys = 'site,geo,device,source,ext,imp'.split(',');
- let validBidRequests = [{
- bidId: 'bidId',
- params: {siteId: 'siteId'}
- }];
- let request = JSON.parse(spec.buildRequests(validBidRequests, {refererInfo: {referer: 'page'}}).data);
- let data = Object.keys(request);
-
- assert.deepEqual(keys, data);
- });
-
- it('should set request keys correct values', function () {
- let validBidRequests = [{
- bidId: 'bidId',
- params: {siteId: 'siteId'},
- }];
- let request = JSON.parse(spec.buildRequests(validBidRequests, {
- refererInfo: {referer: 'page'},
- ortb2: {source: {tid: 'tid'}}
- }).data);
-
- assert.equal(request.source.tid, 'tid');
- assert.equal(request.source.fd, 1);
- });
-
- it('should send info about device', function () {
- config.setConfig({
- device: {w: 100, h: 100}
- });
- let validBidRequests = [{
- bidId: 'bidId',
- params: {adzoneid: '1000'}
- }];
- let request = JSON.parse(spec.buildRequests(validBidRequests, {refererInfo: {page: 'page', domain: 'localhost'}}).data);
-
- assert.equal(request.device.ua, navigator.userAgent);
- assert.equal(request.device.w, 100);
- assert.equal(request.device.h, 100);
- });
-
- it('should send app info', function () {
- config.setConfig({
- app: {id: 'appid'},
- });
- const ortb2 = {app: {name: 'appname'}}
- let validBidRequests = [{
- bidId: 'bidId',
- params: {adzoneid: '1000'},
- ortb2
- }];
- let request = JSON.parse(spec.buildRequests(validBidRequests, {refererInfo: {referer: 'page'}, ortb2}).data);
-
- assert.equal(request.app.id, 'appid');
- assert.equal(request.app.name, 'appname');
- assert.equal(request.site, undefined);
- });
-
- it('should send info about the site', function () {
- config.setConfig({
- site: {
- id: '123123',
- publisher: {
- domain: 'publisher.domain.com'
- }
- },
- });
- const ortb2 = {
- site: {
- publisher: {
- id: 4441,
- name: 'publisher\'s name'
- }
- }
- };
-
- let validBidRequests = [{
- bidId: 'bidId',
- params: {adzoneid: '1000'},
- ortb2
- }];
- let refererInfo = {page: 'page', domain: 'localhost'};
- let request = JSON.parse(spec.buildRequests(validBidRequests, {refererInfo, ortb2}).data);
-
- assert.deepEqual(request.site, {
- domain: 'localhost',
- id: '123123',
- page: refererInfo.page,
- publisher: {
- domain: 'publisher.domain.com',
- id: 4441,
- name: 'publisher\'s name'
- }
- });
- });
-
- it('should pass extended ids', function () {
- let validBidRequests = [{
- bidId: 'bidId',
- params: {},
- userIdAsEids: createEidsArray({
- tdid: 'TTD_ID_FROM_USER_ID_MODULE',
- pubcid: 'pubCommonId_FROM_USER_ID_MODULE'
- })
- }];
-
- let request = JSON.parse(spec.buildRequests(validBidRequests, {refererInfo: {referer: 'page'}}).data);
- assert.deepEqual(request.user.ext.eids, [
- {source: 'adserver.org', uids: [{id: 'TTD_ID_FROM_USER_ID_MODULE', atype: 1, ext: {rtiPartner: 'TDID'}}]},
- {source: 'pubcid.org', uids: [{id: 'pubCommonId_FROM_USER_ID_MODULE', atype: 1}]}
- ]);
- });
-
- it('should send currency if defined', function () {
- config.setConfig({currency: {adServerCurrency: 'EUR'}});
- let validBidRequests = [{params: {}}];
- let refererInfo = {referer: 'page'};
- let request = JSON.parse(spec.buildRequests(validBidRequests, {refererInfo}).data);
-
- assert.deepEqual(request.cur, ['EUR']);
- });
-
- it('should pass supply chain object', function () {
- let validBidRequests = [{
- bidId: 'bidId',
- params: {},
- schain: {
- validation: 'strict',
- config: {
- ver: '1.0'
- }
- }
- }];
-
- let request = JSON.parse(spec.buildRequests(validBidRequests, {refererInfo: {referer: 'page'}}).data);
- assert.deepEqual(request.source.ext.schain, {
- validation: 'strict',
- config: {
- ver: '1.0'
- }
- });
- });
-
- describe('bids', function () {
- it('should add more than one bid to the request', function () {
- let validBidRequests = [{
- bidId: 'bidId',
- params: {siteId: 'siteId'}
- }, {
- bidId: 'bidId2',
- params: {siteId: 'siteId'}
- }];
- let request = JSON.parse(spec.buildRequests(validBidRequests, {refererInfo: {referer: 'page'}}).data);
-
- assert.equal(request.imp.length, 2);
- });
- it('should add incrementing values of id', function () {
- let validBidRequests = [{
- bidId: 'bidId',
- params: {adzoneid: '1000'},
- mediaTypes: {video: {}}
- }, {
- bidId: 'bidId2',
- params: {adzoneid: '1000'},
- mediaTypes: {video: {}}
- }, {
- bidId: 'bidId3',
- params: {adzoneid: '1000'},
- mediaTypes: {video: {}}
- }];
- let imps = JSON.parse(spec.buildRequests(validBidRequests, {refererInfo: {referer: 'page'}}).data).imp;
-
- for (let i = 0; i < 3; i++) {
- assert.equal(imps[i].id, i + 1);
- }
- });
-
- it('should add adzoneid', function () {
- let validBidRequests = [{bidId: 'bidId', params: {adzoneid: 1000}, mediaTypes: {video: {}}},
- {bidId: 'bidId2', params: {adzoneid: 1001}, mediaTypes: {video: {}}},
- {bidId: 'bidId3', params: {adzoneid: 1002}, mediaTypes: {video: {}}}];
- let imps = JSON.parse(spec.buildRequests(validBidRequests, {refererInfo: {referer: 'page'}}).data).imp;
- for (let i = 0; i < 3; i++) {
- assert.equal(imps[i].tagid, validBidRequests[i].params.adzoneid);
- }
- });
-
- describe('price floors', function () {
- it('should not add if floors module not configured', function () {
- const validBidRequests = [{bidId: 'bidId', params: {adzoneid: 1000}, mediaTypes: {video: {}}}];
- let imp = getRequestImps(validBidRequests)[0];
-
- assert.equal(imp.bidfloor, undefined);
- assert.equal(imp.bidfloorcur, undefined);
- });
-
- it('should not add if floor price not defined', function () {
- const validBidRequests = [getBidWithFloor()];
- let imp = getRequestImps(validBidRequests)[0];
-
- assert.equal(imp.bidfloor, undefined);
- assert.equal(imp.bidfloorcur, 'USD');
- });
-
- it('should request floor price in adserver currency', function () {
- config.setConfig({currency: {adServerCurrency: 'DKK'}});
- const validBidRequests = [getBidWithFloor()];
- let imp = getRequestImps(validBidRequests)[0];
-
- assert.equal(imp.bidfloor, undefined);
- assert.equal(imp.bidfloorcur, 'DKK');
- });
-
- it('should add correct floor values', function () {
- const expectedFloors = [1, 1.3, 0.5];
- const validBidRequests = expectedFloors.map(getBidWithFloor);
- let imps = getRequestImps(validBidRequests);
-
- expectedFloors.forEach((floor, index) => {
- assert.equal(imps[index].bidfloor, floor);
- assert.equal(imps[index].bidfloorcur, 'USD');
- });
- });
-
- function getBidWithFloor(floor) {
- return {
- params: {adzoneid: 1},
- mediaTypes: {video: {}},
- getFloor: ({currency}) => {
- return {
- currency: currency,
- floor
- };
- }
- };
- }
- });
-
- describe('multiple media types', function () {
- it('should use all configured media types for bidding', function () {
- let validBidRequests = [{
- bidId: 'bidId',
- params: {adzoneid: 1000},
- mediaTypes: {
- banner: {
- sizes: [[100, 100], [200, 300]]
- },
- video: {}
- }
- }, {
- bidId: 'bidId1',
- params: {adzoneid: 1000},
- mediaTypes: {
- video: {},
- native: {}
- }
- }, {
- bidId: 'bidId2',
- params: {adzoneid: 1000},
- nativeParams: {
- title: {required: true, len: 140}
- },
- mediaTypes: {
- banner: {
- sizes: [[100, 100], [200, 300]]
- },
- native: {},
- video: {}
- }
- }];
- let [first, second, third] = JSON.parse(spec.buildRequests(validBidRequests, {refererInfo: {referer: 'page'}}).data).imp;
-
- assert.ok(first.banner);
- assert.ok(first.video);
- assert.equal(first.native, undefined);
-
- assert.ok(second.video);
- assert.equal(second.banner, undefined);
- assert.equal(second.native, undefined);
-
- assert.ok(third.native);
- assert.ok(third.video);
- assert.ok(third.banner);
- });
- });
-
- describe('banner', function () {
- it('should convert sizes to openrtb format', function () {
- let validBidRequests = [{
- bidId: 'bidId',
- params: {adzoneid: 1000},
- mediaTypes: {
- banner: {
- sizes: [[100, 100], [200, 300]]
- }
- }
- }];
- let {banner} = JSON.parse(spec.buildRequests(validBidRequests, {refererInfo: {referer: 'page'}}).data).imp[0];
- assert.deepEqual(banner, {
- format: [{w: 100, h: 100}, {w: 200, h: 300}]
- });
- });
- });
-
- describe('video', function () {
- it('should pass video mediatype config', function () {
- let validBidRequests = [{
- bidId: 'bidId',
- params: {adzoneid: 1000},
- mediaTypes: {
- video: {
- playerSize: [640, 480],
- context: 'outstream',
- mimes: ['video/mp4']
- }
- }
- }];
- let {video} = JSON.parse(spec.buildRequests(validBidRequests, {refererInfo: {referer: 'page'}}).data).imp[0];
- assert.deepEqual(video, {
- playerSize: [640, 480],
- context: 'outstream',
- mimes: ['video/mp4']
- });
- });
- });
-
- describe('native', function () {
- describe('assets', function () {
- it('should set correct asset id', function () {
- let validBidRequests = [{
- bidId: 'bidId',
- params: {adzoneid: 1000},
- nativeParams: {
- title: {required: true, len: 140},
- image: {required: false, wmin: 836, hmin: 627, w: 325, h: 300, mimes: ['image/jpg', 'image/gif']},
- body: {len: 140}
- }
- }];
- let nativeRequest = JSON.parse(spec.buildRequests(validBidRequests, {refererInfo: {referer: 'page'}}).data).imp[0].native.request;
- let assets = JSON.parse(nativeRequest).assets;
-
- assert.equal(assets[0].id, 0);
- assert.equal(assets[1].id, 3);
- assert.equal(assets[2].id, 4);
- });
- it('should add required key if it is necessary', function () {
- let validBidRequests = [{
- bidId: 'bidId',
- params: {adzoneid: 1000},
- nativeParams: {
- title: {required: true, len: 140},
- image: {required: false, wmin: 836, hmin: 627, w: 325, h: 300, mimes: ['image/jpg', 'image/gif']},
- body: {len: 140},
- sponsoredBy: {required: true, len: 140}
- }
- }];
-
- let nativeRequest = JSON.parse(spec.buildRequests(validBidRequests, {refererInfo: {referer: 'page'}}).data).imp[0].native.request;
- let assets = JSON.parse(nativeRequest).assets;
-
- assert.equal(assets[0].required, 1);
- assert.ok(!assets[1].required);
- assert.ok(!assets[2].required);
- assert.equal(assets[3].required, 1);
- });
-
- it('should map img and data assets', function () {
- let validBidRequests = [{
- bidId: 'bidId',
- params: {adzoneid: 1000},
- nativeParams: {
- title: {required: true, len: 140},
- image: {required: true, sizes: [150, 50]},
- icon: {required: false, sizes: [50, 50]},
- body: {required: false, len: 140},
- sponsoredBy: {required: true},
- cta: {required: false},
- clickUrl: {required: false}
- }
- }];
-
- let nativeRequest = JSON.parse(spec.buildRequests(validBidRequests, {refererInfo: {referer: 'page'}}).data).imp[0].native.request;
- let assets = JSON.parse(nativeRequest).assets;
- assert.ok(assets[0].title);
- assert.equal(assets[0].title.len, 140);
- assert.deepEqual(assets[1].img, {type: 3, w: 150, h: 50});
- assert.deepEqual(assets[2].img, {type: 1, w: 50, h: 50});
- assert.deepEqual(assets[3].data, {type: 2, len: 140});
- assert.deepEqual(assets[4].data, {type: 1});
- assert.deepEqual(assets[5].data, {type: 12});
- assert.ok(!assets[6]);
- });
-
- describe('icon/image sizing', function () {
- it('should flatten sizes and utilise first pair', function () {
- const validBidRequests = [{
- bidId: 'bidId',
- params: {adzoneid: 1000},
- nativeParams: {
- image: {
- sizes: [[200, 300], [100, 200]]
- },
- }
- }];
-
- let nativeRequest = JSON.parse(spec.buildRequests(validBidRequests, {refererInfo: {referer: 'page'}}).data).imp[0].native.request;
- let assets = JSON.parse(nativeRequest).assets;
- assert.ok(assets[0].img);
- assert.equal(assets[0].img.w, 200);
- assert.equal(assets[0].img.h, 300);
- });
- });
-
- it('should utilise aspect_ratios', function () {
- const validBidRequests = [{
- bidId: 'bidId',
- params: {adzoneid: 1000},
- nativeParams: {
- image: {
- aspect_ratios: [{
- min_width: 100,
- ratio_height: 3,
- ratio_width: 1
- }]
- },
- icon: {
- aspect_ratios: [{
- min_width: 10,
- ratio_height: 5,
- ratio_width: 2
- }]
- }
- }
- }];
-
- let nativeRequest = JSON.parse(spec.buildRequests(validBidRequests, {refererInfo: {referer: 'page'}}).data).imp[0].native.request;
- let assets = JSON.parse(nativeRequest).assets;
- assert.ok(assets[0].img);
- assert.equal(assets[0].img.wmin, 100);
- assert.equal(assets[0].img.hmin, 300);
-
- assert.ok(assets[1].img);
- assert.equal(assets[1].img.wmin, 10);
- assert.equal(assets[1].img.hmin, 25);
- });
-
- it('should not throw error if aspect_ratios config is not defined', function () {
- const validBidRequests = [{
- bidId: 'bidId',
- params: {adzoneid: 1000},
- nativeParams: {
- image: {
- aspect_ratios: []
- },
- icon: {
- aspect_ratios: []
- }
- }
- }];
-
- assert.doesNotThrow(() => spec.buildRequests(validBidRequests, {refererInfo: {referer: 'page'}}));
- });
- });
-
- it('should expect any dimensions if min_width not passed', function () {
- const validBidRequests = [{
- bidId: 'bidId',
- params: {adzoneid: 1000},
- nativeParams: {
- image: {
- aspect_ratios: [{
- ratio_height: 3,
- ratio_width: 1
- }]
- }
- }
- }];
-
- let nativeRequest = JSON.parse(spec.buildRequests(validBidRequests, {refererInfo: {referer: 'page'}}).data).imp[0].native.request;
- let assets = JSON.parse(nativeRequest).assets;
- assert.ok(assets[0].img);
- assert.equal(assets[0].img.wmin, 0);
- assert.equal(assets[0].img.hmin, 0);
- assert.ok(!assets[1]);
- });
- });
- });
-
- function getRequestImps(validBidRequests) {
- return JSON.parse(spec.buildRequests(validBidRequests, {refererInfo: {referer: 'page'}}).data).imp;
- }
- });
-
- describe('interpretResponse', function () {
- it('should return if no body in response', function () {
- let serverResponse = {};
- let bidRequest = {};
-
- assert.ok(!spec.interpretResponse(serverResponse, bidRequest));
- });
- it('should return more than one bids', function () {
- let serverResponse = {
- body: {
- seatbid: [{
- bid: [{
- impid: '1',
- native: {ver: '1.1', link: {url: 'link'}, assets: [{id: 1, title: {text: 'Asset title text'}}]}
- }]
- }, {
- bid: [{
- impid: '2',
- native: {ver: '1.1', link: {url: 'link'}, assets: [{id: 1, data: {value: 'Asset title text'}}]}
- }]
- }]
- }
- };
- let bidRequest = {
- data: {},
- bids: [
- {
- bidId: 'bidId1',
- params: {adzoneid: 1000},
- nativeParams: {
- title: {required: true, len: 140},
- image: {required: false, wmin: 836, hmin: 627, w: 325, h: 300, mimes: ['image/jpg', 'image/gif']},
- body: {len: 140}
- }
- },
- {
- bidId: 'bidId2',
- params: {adzoneid: 1000},
- nativeParams: {
- title: {required: true, len: 140},
- image: {required: false, wmin: 836, hmin: 627, w: 325, h: 300, mimes: ['image/jpg', 'image/gif']},
- body: {len: 140}
- }
- }
- ]
- };
-
- bids = spec.interpretResponse(serverResponse, bidRequest);
- assert.equal(spec.interpretResponse(serverResponse, bidRequest).length, 2);
- });
-
- it('should set correct values to bid', function () {
- let nativeExample1 = {
- assets: [],
- link: {url: 'link'},
- imptrackers: ['imptrackers url1', 'imptrackers url2']
- }
-
- let serverResponse = {
- body: {
- id: null,
- bidid: null,
- seatbid: [{
- bid: [
- {
- impid: '1',
- price: 93.1231,
- crid: '12312312',
- adm: JSON.stringify(nativeExample1),
- dealid: 'deal-id',
- adomain: ['demo.com'],
- ext: {
- crType: 'native',
- advertiser_id: 'adv1',
- advertiser_name: 'advname',
- agency_name: 'agname',
- mediaType: 'native'
- }
- }
- ]
- }],
- cur: 'EUR'
- }
- };
- let bidRequest = {
- data: {},
- bids: [
- {
- bidId: 'bidId1',
- params: {adzoneid: 1000},
- nativeParams: {
- title: {required: true, len: 140},
- image: {required: false, wmin: 836, hmin: 627, w: 325, h: 300, mimes: ['image/jpg', 'image/gif']},
- body: {len: 140}
- }
- }
- ]
- };
-
- const bids = spec.interpretResponse(serverResponse, bidRequest);
- const bid = serverResponse.body.seatbid[0].bid[0];
- assert.deepEqual(bids[0].requestId, bidRequest.bids[0].bidId);
- assert.deepEqual(bids[0].cpm, bid.price);
- assert.deepEqual(bids[0].creativeId, bid.crid);
- assert.deepEqual(bids[0].ttl, 300);
- assert.deepEqual(bids[0].netRevenue, false);
- assert.deepEqual(bids[0].currency, serverResponse.body.cur);
- assert.deepEqual(bids[0].mediaType, 'native');
- assert.deepEqual(bids[0].meta.mediaType, 'native');
- assert.deepEqual(bids[0].meta.advertiserDomains, ['demo.com']);
-
- assert.deepEqual(bids[0].meta.advertiserName, 'advname');
- assert.deepEqual(bids[0].meta.agencyName, 'agname');
-
- assert.deepEqual(bids[0].dealId, 'deal-id');
- });
-
- it('should return empty when there is no bids in response', function () {
- const serverResponse = {
- body: {
- id: null,
- bidid: null,
- seatbid: [{bid: []}],
- cur: 'EUR'
- }
- };
- let bidRequest = {
- data: {},
- bids: [{bidId: 'bidId1'}]
- };
- const result = spec.interpretResponse(serverResponse, bidRequest)[0];
- assert.ok(!result);
- });
-
- describe('banner', function () {
- it('should set ad content on response', function () {
- let serverResponse = {
- body: {
- seatbid: [{
- bid: [{impid: '1', adm: '
+
+
+
+
+ ]]>
+
+ ES 00:00:15 00:00:15
- `
+ `;
return {
- body: { bids: [
- {
- 'creative': {
- 'video': {
- 'content': isInvalidVast ? invalidVast : validVast,
- 'height': 250,
- 'width': 300
+ body: {
+ bids: [
+ {
+ creative: {
+ video: {
+ content: isInvalidVast ? invalidVast : validVast,
+ height: 250,
+ width: 300,
+ },
+ media_type: 'video',
+ creativeId: 0,
},
- 'media_type': 'video',
- 'creativeId': 0,
- },
- 'price': 0,
- 'id': '8121',
- 'token': 'token',
- 'mode': 'rtb',
- 'extras': {
- 'deal_id': '34567ertyaza',
- 'transaction_id': '2def0c5b2a7f6e'
+ price: 0,
+ id: '8121',
+ token: 'token',
+ mode: 'rtb',
+ extras: {
+ deal_id: '34567ertyaza',
+ transaction_id: '2def0c5b2a7f6e',
+ },
+ currency: 'EUR',
},
- 'currency': 'EUR'
- }
- ],
- userSyncs: []}
- }
-}
+ ],
+ userSyncs: [],
+ },
+ };
+};
/**
*
@@ -279,9 +297,9 @@ const testsGetMetaList = [
{
title: 'Should return empty array if there are no parameters',
args: {
- fn: getMetaList()
+ fn: getMetaList(),
},
- want: []
+ want: [],
},
{
title: 'Should return list of metas with name associated',
@@ -313,18 +331,63 @@ const testsGetMetaList = [
key: 'property',
value: `'article:${'test'}'`,
},
- ]
- }
-]
+ ],
+ },
+];
-describe('BLIINK Adapter getMetaList', function() {
+describe('BLIINK Adapter getMetaList', function () {
for (const test of testsGetMetaList) {
it(test.title, () => {
- const res = test.args.fn
- expect(res).to.eql(test.want)
- })
+ const res = test.args.fn;
+ expect(res).to.eql(test.want);
+ });
}
-})
+});
+const GetUserIds = [
+ {
+ title: 'Should return undefined if there are no parameters',
+ args: {
+ fn: getUserIds(),
+ },
+ want: undefined,
+ },
+ {
+ title: 'Should return eids if exists',
+ args: {
+ fn: getUserIds([{ userIdAsEids: [
+ {
+ 'source': 'criteo.com',
+ 'uids': [
+ {
+ 'id': 'testId',
+ 'atype': 1
+ }
+ ]
+ }
+ ] }]),
+ },
+ want: [
+ {
+ 'source': 'criteo.com',
+ 'uids': [
+ {
+ 'id': 'testId',
+ 'atype': 1
+ }
+ ]
+ }
+ ],
+ },
+];
+
+describe('BLIINK Adapter getUserIds', function () {
+ for (const test of GetUserIds) {
+ it(test.title, () => {
+ const res = test.args.fn;
+ expect(res).to.eql(test.want);
+ });
+ }
+});
/**
* @description Array of tests used in describe function below
@@ -349,127 +412,142 @@ const testsIsBidRequestValid = [
{
title: 'isBidRequestValid format not valid',
args: {
- fn: spec.isBidRequestValid({})
+ fn: spec.isBidRequestValid({}),
},
want: false,
},
{
title: 'isBidRequestValid does not receive any bid',
args: {
- fn: spec.isBidRequestValid()
+ fn: spec.isBidRequestValid(),
},
want: false,
},
{
title: 'isBidRequestValid Receive a valid bid',
args: {
- fn: spec.isBidRequestValid(getConfigBid('banner'))
+ fn: spec.isBidRequestValid(getConfigBid('banner')),
},
want: true,
- }
-]
+ },
+];
-describe('BLIINK Adapter isBidRequestValid', function() {
+describe('BLIINK Adapter isBidRequestValid', function () {
for (const test of testsIsBidRequestValid) {
it(test.title, () => {
- const res = test.args.fn
- expect(res).to.eql(test.want)
- })
+ const res = test.args.fn;
+ expect(res).to.eql(test.want);
+ });
}
-})
+});
-const vastXml = getConfigInterpretResponseRTB().body.bids[0].creative.video.content
+const vastXml =
+ getConfigInterpretResponseRTB().body.bids[0].creative.video.content;
const testsInterpretResponse = [
{
title: 'Should construct bid for video instream',
args: {
- fn: spec.interpretResponse(getConfigInterpretResponseRTB(false))
+ fn: spec.interpretResponse(getConfigInterpretResponseRTB(false)),
},
- want: [{
- cpm: 0,
- currency: 'EUR',
- height: 250,
- width: 300,
- creativeId: '34567ertyaza',
- mediaType: 'video',
- netRevenue: true,
- requestId: '2def0c5b2a7f6e',
- ttl: 300,
- vastXml,
- vastUrl: 'data:text/xml;charset=utf-8;base64,' + btoa(vastXml.replace(/\\"/g, '"'))
- }]
+ want: [
+ {
+ cpm: 0,
+ currency: 'EUR',
+ height: 250,
+ width: 300,
+ creativeId: '34567ertyaza',
+ mediaType: 'video',
+ netRevenue: true,
+ requestId: '2def0c5b2a7f6e',
+ ttl: 300,
+ vastXml,
+ vastUrl:
+ 'data:text/xml;charset=utf-8;base64,' +
+ btoa(vastXml.replace(/\\"/g, '"')),
+ },
+ ],
},
{
title: 'ServerResponse with message: invalid tag, return empty array',
args: {
- fn: spec.interpretResponse(getConfigInterpretResponse(true))
+ fn: spec.interpretResponse(getConfigInterpretResponse(true)),
},
- want: []
+ want: [],
},
{
title: 'ServerResponse with mediaType banner',
args: {
- fn: spec.interpretResponse({body: {bids: [getConfigBannerBid()]}}),
+ fn: spec.interpretResponse({ body: { bids: [getConfigBannerBid()] } }),
},
- want: [{
- ad: '',
- cpm: 1,
- creativeId: '34567erty',
- currency: 'EUR',
- height: 250,
- mediaType: 'banner',
- netRevenue: true,
- requestId: '2def0c5b2a7f6e',
- ttl: 300,
- width: 300
- }]
+ want: [
+ {
+ ad: '',
+ cpm: 1,
+ creativeId: '34567erty',
+ currency: 'EUR',
+ height: 250,
+ mediaType: 'banner',
+ netRevenue: true,
+ requestId: '2def0c5b2a7f6e',
+ ttl: 300,
+ width: 300,
+ },
+ ],
},
{
title: 'ServerResponse with unhandled mediaType, return empty array',
args: {
- fn: spec.interpretResponse({body: {bids: [{...getConfigBannerBid(),
- creative: {
- unknown: {
- adm: '',
- height: 250,
- width: 300,
- },
- media_type: 'unknown',
- creativeId: 125,
- requestId: '2def0c5b2a7f6e',
- }}]}}),
+ fn: spec.interpretResponse({
+ body: {
+ bids: [
+ {
+ ...getConfigBannerBid(),
+ creative: {
+ unknown: {
+ adm: '',
+ height: 250,
+ width: 300,
+ },
+ media_type: 'unknown',
+ creativeId: 125,
+ requestId: '2def0c5b2a7f6e',
+ },
+ },
+ ],
+ },
+ }),
},
- want: []
+ want: [],
},
-]
+];
-describe('BLIINK Adapter interpretResponse', function() {
+describe('BLIINK Adapter interpretResponse', function () {
for (const test of testsInterpretResponse) {
it(test.title, () => {
- const res = test.args.fn
+ const res = test.args.fn;
if (res) {
- expect(res).to.eql(test.want)
+ expect(res).to.eql(test.want);
}
- })
+ });
}
-})
+});
/**
* @description Array of tests used in describe function below
* @type {[
* {args:
* {fn: {
- * cpm: number,
- * netRevenue: boolean,
- * ad, requestId,
- * meta: {mediaType},
- * width: number,
- * currency: string,
- * ttl: number,
- * creativeId: number,
- * height: number
+ * cpm: number,
+ * netRevenue: boolean,
+ * ad, requestId,
+ * meta: {mediaType},
+ * width: number,
+ * currency: string,
+ * ttl: number,
+ * creativeId: number,
+ * height: number
* }
* }, want, title: string}]}
*/
@@ -478,21 +556,26 @@ const testsBuildBid = [
{
title: 'Should return null if no bid passed in parameters',
args: {
- fn: buildBid()
+ fn: buildBid(),
},
- want: null
+ want: null,
},
{
title: 'Input data must respect the output model',
args: {
- fn: buildBid({ id: 1, test: '123' }, { id: 2, test: '345' }, false, false)
+ fn: buildBid(
+ { id: 1, test: '123' },
+ { id: 2, test: '345' },
+ false,
+ false
+ ),
},
- want: null
+ want: null,
},
{
title: 'input data respect the output model for video',
args: {
- fn: buildBid(getConfigVideoBid('video'), getConfigCreativeVideo())
+ fn: buildBid(getConfigVideoBid('video'), getConfigCreativeVideo()),
},
want: {
requestId: getConfigBid('video').bidId,
@@ -504,25 +587,31 @@ const testsBuildBid = [
creativeId: getConfigVideoBid().extras.deal_id,
netRevenue: true,
vastXml: getConfigCreativeVideo().vastXml,
- vastUrl: 'data:text/xml;charset=utf-8;base64,' + btoa(getConfigCreativeVideo().vastXml.replace(/\\"/g, '"')),
+ vastUrl:
+ 'data:text/xml;charset=utf-8;base64,' +
+ btoa(getConfigCreativeVideo().vastXml.replace(/\\"/g, '"')),
ttl: 300,
- }
+ },
},
{
title: 'use default height width output model for video',
args: {
- fn: buildBid({...getConfigVideoBid('video'),
- creative: {
- video: {
- content:
- '![]()
',
+ 'adid': '1780626232977441',
+ 'adomain': [
+ 'swi.esxcmnb.com'
+ ],
+ 'iurl': 'https://p16-ttam-va.ibyteimg.com/origin/ad-site-i18n-sg/202310245d0d598b3ff5993c4f129a8b',
+ 'cid': '1780626232977441',
+ 'crid': '1780626232977441',
+ 'attr': [
+ 4
+ ],
+ 'w': 640,
+ 'h': 640,
+ 'mtype': 1,
+ 'ext': {
+ 'pangle': {
+ 'adtype': 8
+ },
+ 'event_notification_token': {
+ 'payload': '980589944:8:1450:7492'
+ }
+ }
+ }
+ ],
+ 'seat': 'pangle'
+ }
+ ]
+ }
+ };
+ it('should set mediaType to banner', function() {
+ const request = spec.buildRequests(multiRequest, bidderRequest)[0];
+ const interpretedResponse = spec.interpretResponse(bannerResponse, request);
+ const bid = interpretedResponse[0];
+ expect(bid.mediaType).to.equal('banner');
+ })
+ it('should set mediaType to video', function() {
+ const request = spec.buildRequests(multiRequest, bidderRequest)[0];
+ const interpretedResponse = spec.interpretResponse(videoResponse, request);
+ const bid = interpretedResponse[0];
+ expect(bid.mediaType).to.equal('video');
+ })
+});
diff --git a/test/spec/modules/acuityAdsBidAdapter_spec.js b/test/spec/modules/pgamsspBidAdapter_spec.js
similarity index 96%
rename from test/spec/modules/acuityAdsBidAdapter_spec.js
rename to test/spec/modules/pgamsspBidAdapter_spec.js
index 05c59036ff3..0766219eda8 100644
--- a/test/spec/modules/acuityAdsBidAdapter_spec.js
+++ b/test/spec/modules/pgamsspBidAdapter_spec.js
@@ -1,11 +1,11 @@
import { expect } from 'chai';
-import { spec } from '../../../modules/acuityAdsBidAdapter';
+import { spec } from '../../../modules/pgamsspBidAdapter.js';
import { BANNER, VIDEO, NATIVE } from '../../../src/mediaTypes.js';
import { getUniqueIdentifierStr } from '../../../src/utils.js';
-const bidder = 'acuityads'
+const bidder = 'pgamssp'
-describe('AcuityAdsBidAdapter', function () {
+describe('PGAMBidAdapter', function () {
const bids = [
{
bidId: getUniqueIdentifierStr(),
@@ -104,7 +104,7 @@ describe('AcuityAdsBidAdapter', function () {
});
it('Returns valid URL', function () {
- expect(serverRequest.url).to.equal('https://prebid.admanmedia.com/pbjs');
+ expect(serverRequest.url).to.equal('https://us-east.pgammedia.com/pbjs');
});
it('Returns general data valid', function () {
@@ -145,6 +145,7 @@ describe('AcuityAdsBidAdapter', function () {
expect(placement.schain).to.be.an('object');
expect(placement.bidfloor).to.exist.and.to.equal(0);
expect(placement.type).to.exist.and.to.equal('publisher');
+ expect(placement.eids).to.exist.and.to.be.an('array');
if (placement.adFormat === BANNER) {
expect(placement.sizes).to.be.an('array');
@@ -382,7 +383,7 @@ describe('AcuityAdsBidAdapter', function () {
expect(syncData[0].type).to.be.a('string')
expect(syncData[0].type).to.equal('image')
expect(syncData[0].url).to.be.a('string')
- expect(syncData[0].url).to.equal('https://cs.admanmedia.com/image?pbjs=1&gdpr=1&gdpr_consent=ALL&coppa=0')
+ expect(syncData[0].url).to.equal('https://cs.pgammedia.com/image?pbjs=1&gdpr=1&gdpr_consent=ALL&coppa=0')
});
it('Should return array of objects with proper sync config , include CCPA', function() {
const syncData = spec.getUserSyncs({}, {}, {}, {
@@ -393,7 +394,7 @@ describe('AcuityAdsBidAdapter', function () {
expect(syncData[0].type).to.be.a('string')
expect(syncData[0].type).to.equal('image')
expect(syncData[0].url).to.be.a('string')
- expect(syncData[0].url).to.equal('https://cs.admanmedia.com/image?pbjs=1&ccpa_consent=1---&coppa=0')
+ expect(syncData[0].url).to.equal('https://cs.pgammedia.com/image?pbjs=1&ccpa_consent=1---&coppa=0')
});
});
});
diff --git a/test/spec/modules/prebidServerBidAdapter_spec.js b/test/spec/modules/prebidServerBidAdapter_spec.js
index ad6c4318cc7..5b591804b95 100644
--- a/test/spec/modules/prebidServerBidAdapter_spec.js
+++ b/test/spec/modules/prebidServerBidAdapter_spec.js
@@ -14,7 +14,6 @@ import {config} from 'src/config.js';
import * as events from 'src/events.js';
import CONSTANTS from 'src/constants.json';
import {server} from 'test/mocks/xhr.js';
-import {createEidsArray} from 'modules/userId/eids.js';
import 'modules/appnexusBidAdapter.js'; // appnexus alias test
import 'modules/rubiconBidAdapter.js'; // rubicon alias test
import 'src/prebid.js'; // $$PREBID_GLOBAL$$.aliasBidder test
@@ -34,11 +33,9 @@ import {auctionManager} from '../../../src/auctionManager.js';
import {stubAuctionIndex} from '../../helpers/indexStub.js';
import {addComponentAuction, registerBidder} from 'src/adapters/bidderFactory.js';
import {getGlobal} from '../../../src/prebidGlobal.js';
-import {syncAddFPDEnrichments, syncAddFPDToBidderRequest} from '../../helpers/fpd.js';
+import {syncAddFPDToBidderRequest} from '../../helpers/fpd.js';
import {deepSetValue} from '../../../src/utils.js';
-import {sandbox} from 'sinon';
import {ACTIVITY_TRANSMIT_UFPD} from '../../../src/activities/activities.js';
-import {activityParams} from '../../../src/activities/activityParams.js';
import {MODULE_TYPE_PREBID} from '../../../src/activities/modules.js';
let CONFIG = {
@@ -712,8 +709,8 @@ describe('S2S Adapter', function () {
beforeEach(() => {
s2sReq = {
...REQUEST,
- ortb2Fragments: {global: {source: {tid: 'mock-tid'}}},
- ad_units: REQUEST.ad_units.map(au => ({...au, ortb2Imp: {ext: {tid: 'mock-tid'}}}))
+ ortb2Fragments: {global: {}},
+ ad_units: REQUEST.ad_units.map(au => ({...au, ortb2Imp: {ext: {tid: 'mock-tid'}}})),
};
BID_REQUESTS[0].bids[0].ortb2Imp = {ext: {tid: 'mock-tid'}};
});
@@ -726,15 +723,15 @@ describe('S2S Adapter', function () {
it('should not be set when transmitTid is not allowed, with ext.prebid.createtids: false', () => {
config.setConfig({ s2sConfig: CONFIG, enableTIDs: false });
const req = makeRequest();
- expect(req.source.tid).to.not.exist;
- expect(req.imp[0].ext.tid).to.not.exist;
+ expect(req.source?.tid).to.not.exist;
+ expect(req.imp[0].ext?.tid).to.not.exist;
expect(req.ext.prebid.createtids).to.equal(false);
});
- it('should be picked from FPD otherwise', () => {
+ it('should be set to auction ID otherwise', () => {
config.setConfig({s2sConfig: CONFIG, enableTIDs: true});
const req = makeRequest();
- expect(req.source.tid).to.eql('mock-tid');
+ expect(req.source.tid).to.eql(BID_REQUESTS[0].auctionId);
expect(req.imp[0].ext.tid).to.eql('mock-tid');
})
})
@@ -2054,7 +2051,7 @@ describe('S2S Adapter', function () {
const bidRequests = utils.deepClone(BID_REQUESTS);
adapter.callBids(REQUEST, bidRequests, addBidResponse, done, ajax);
- const parsedRequestBody = JSON.parse(server.requests[1].requestBody);
+ const parsedRequestBody = JSON.parse(server.requests.find(req => req.method === 'POST').requestBody);
expect(parsedRequestBody.cur).to.deep.equal(['NZ']);
});
@@ -2876,6 +2873,15 @@ describe('S2S Adapter', function () {
events.emit.restore();
});
+ it('triggers BIDDER_ERROR on server error', () => {
+ config.setConfig({ s2sConfig: CONFIG });
+ adapter.callBids(REQUEST, BID_REQUESTS, addBidResponse, done, ajax);
+ server.requests[0].respond(400, {}, {});
+ BID_REQUESTS.forEach(bidderRequest => {
+ sinon.assert.calledWith(events.emit, CONSTANTS.EVENTS.BIDDER_ERROR, sinon.match({bidderRequest}))
+ })
+ })
+
// TODO: test dependent on pbjs_api_spec. Needs to be isolated
it('does not call addBidResponse and calls done when ad unit not set', function () {
config.setConfig({ s2sConfig: CONFIG });
@@ -3416,29 +3422,6 @@ describe('S2S Adapter', function () {
});
});
describe('when the response contains ext.prebid.fledge', () => {
- let fledgeStub, request, bidderRequests;
-
- function fledgeHook(next, ...args) {
- fledgeStub(...args);
- }
-
- before(() => {
- addComponentAuction.before(fledgeHook);
- });
-
- after(() => {
- addComponentAuction.getHooks({hook: fledgeHook}).remove();
- })
-
- beforeEach(function () {
- fledgeStub = sinon.stub();
- config.setConfig({CONFIG});
- request = deepClone(REQUEST);
- request.ad_units.forEach(au => deepSetValue(au, 'ortb2Imp.ext.ae', 1));
- bidderRequests = deepClone(BID_REQUESTS);
- bidderRequests.forEach(req => req.fledgeEnabled = true);
- });
-
const AU = 'div-gpt-ad-1460505748561-0';
const FLEDGE_RESP = {
ext: {
@@ -3447,12 +3430,14 @@ describe('S2S Adapter', function () {
auctionconfigs: [
{
impid: AU,
+ bidder: 'appnexus',
config: {
id: 1
}
},
{
impid: AU,
+ bidder: 'other',
config: {
id: 2
}
@@ -3463,20 +3448,62 @@ describe('S2S Adapter', function () {
}
}
+ let fledgeStub, request, bidderRequests;
+
+ function fledgeHook(next, ...args) {
+ fledgeStub(...args);
+ }
+
+ before(() => {
+ addComponentAuction.before(fledgeHook);
+ });
+
+ after(() => {
+ addComponentAuction.getHooks({hook: fledgeHook}).remove();
+ })
+
+ beforeEach(function () {
+ fledgeStub = sinon.stub();
+ config.setConfig({CONFIG});
+ bidderRequests = deepClone(BID_REQUESTS);
+ AU
+ bidderRequests.forEach(req => {
+ Object.assign(req, {
+ fledgeEnabled: true,
+ ortb2: {
+ fpd: 1
+ }
+ })
+ req.bids.forEach(bid => {
+ Object.assign(bid, {
+ ortb2Imp: {
+ fpd: 2
+ }
+ })
+ })
+ });
+ request = deepClone(REQUEST);
+ request.ad_units.forEach(au => deepSetValue(au, 'ortb2Imp.ext.ae', 1));
+ });
+
+ function expectFledgeCalls() {
+ const auctionId = bidderRequests[0].auctionId;
+ sinon.assert.calledWith(fledgeStub, sinon.match({auctionId, adUnitCode: AU, ortb2: bidderRequests[0].ortb2, ortb2Imp: bidderRequests[0].bids[0].ortb2Imp}), {id: 1})
+ sinon.assert.calledWith(fledgeStub, sinon.match({auctionId, adUnitCode: AU, ortb2: undefined, ortb2Imp: undefined}), {id: 2})
+ }
+
it('calls addComponentAuction alongside addBidResponse', function () {
adapter.callBids(request, bidderRequests, addBidResponse, done, ajax);
server.requests[0].respond(200, {}, JSON.stringify(mergeDeep({}, RESPONSE_OPENRTB, FLEDGE_RESP)));
expect(addBidResponse.called).to.be.true;
- sinon.assert.calledWith(fledgeStub, AU, {id: 1});
- sinon.assert.calledWith(fledgeStub, AU, {id: 2});
+ expectFledgeCalls();
});
it('calls addComponentAuction when there is no bid in the response', () => {
adapter.callBids(request, bidderRequests, addBidResponse, done, ajax);
server.requests[0].respond(200, {}, JSON.stringify(FLEDGE_RESP));
expect(addBidResponse.called).to.be.false;
- sinon.assert.calledWith(fledgeStub, AU, {id: 1});
- sinon.assert.calledWith(fledgeStub, AU, {id: 2});
+ expectFledgeCalls();
})
});
});
@@ -3626,33 +3653,6 @@ describe('S2S Adapter', function () {
sinon.assert.calledOnce(logErrorSpy);
});
- it('should configure the s2sConfig object with appnexus vendor defaults unless specified by user', function () {
- const options = {
- accountId: '123',
- bidders: ['appnexus'],
- defaultVendor: 'appnexus',
- timeout: 750
- };
-
- config.setConfig({ s2sConfig: options });
- sinon.assert.notCalled(logErrorSpy);
-
- let vendorConfig = config.getConfig('s2sConfig');
- expect(vendorConfig).to.have.property('accountId', '123');
- expect(vendorConfig).to.have.property('adapter', 'prebidServer');
- expect(vendorConfig.bidders).to.deep.equal(['appnexus']);
- expect(vendorConfig.enabled).to.be.true;
- expect(vendorConfig.endpoint).to.deep.equal({
- p1Consent: 'https://prebid.adnxs.com/pbs/v1/openrtb2/auction',
- noP1Consent: 'https://prebid.adnxs-simple.com/pbs/v1/openrtb2/auction'
- });
- expect(vendorConfig.syncEndpoint).to.deep.equal({
- p1Consent: 'https://prebid.adnxs.com/pbs/v1/cookie_sync',
- noP1Consent: 'https://prebid.adnxs-simple.com/pbs/v1/cookie_sync'
- });
- expect(vendorConfig).to.have.property('timeout', 750);
- });
-
it('should configure the s2sConfig object with appnexuspsp vendor defaults unless specified by user', function () {
const options = {
accountId: '123',
@@ -3673,7 +3673,10 @@ describe('S2S Adapter', function () {
p1Consent: 'https://ib.adnxs.com/openrtb2/prebid',
noP1Consent: 'https://ib.adnxs-simple.com/openrtb2/prebid'
});
- expect(vendorConfig.syncEndpoint).to.be.undefined;
+ expect(vendorConfig.syncEndpoint).to.deep.equal({
+ p1Consent: 'https://prebid.adnxs.com/pbs/v1/cookie_sync',
+ noP1Consent: 'https://prebid.adnxs-simple.com/pbs/v1/cookie_sync'
+ });
expect(vendorConfig).to.have.property('timeout', 750);
});
@@ -3758,6 +3761,74 @@ describe('S2S Adapter', function () {
})
});
+ it('should configure the s2sConfig object with openwrap vendor defaults unless specified by user', function () {
+ const options = {
+ accountId: '1234',
+ bidders: ['pubmatic'],
+ defaultVendor: 'openwrap'
+ };
+
+ config.setConfig({ s2sConfig: options });
+ sinon.assert.notCalled(logErrorSpy);
+
+ let vendorConfig = config.getConfig('s2sConfig');
+ expect(vendorConfig).to.have.property('accountId', '1234');
+ expect(vendorConfig).to.have.property('adapter', 'prebidServer');
+ expect(vendorConfig.bidders).to.deep.equal(['pubmatic']);
+ expect(vendorConfig.enabled).to.be.true;
+ expect(vendorConfig.endpoint).to.deep.equal({
+ p1Consent: 'https://ow.pubmatic.com/openrtb2/auction?source=pbjs',
+ noP1Consent: 'https://ow.pubmatic.com/openrtb2/auction?source=pbjs'
+ });
+ expect(vendorConfig).to.have.property('timeout', 500);
+ });
+
+ it('should return proper defaults', function () {
+ const options = {
+ accountId: '1234',
+ bidders: ['pubmatic'],
+ defaultVendor: 'openwrap',
+ timeout: 500
+ };
+
+ config.setConfig({ s2sConfig: options });
+ expect(config.getConfig('s2sConfig')).to.deep.equal({
+ 'accountId': '1234',
+ 'adapter': 'prebidServer',
+ 'bidders': ['pubmatic'],
+ 'defaultVendor': 'openwrap',
+ 'enabled': true,
+ 'endpoint': {
+ p1Consent: 'https://ow.pubmatic.com/openrtb2/auction?source=pbjs',
+ noP1Consent: 'https://ow.pubmatic.com/openrtb2/auction?source=pbjs'
+ },
+ 'timeout': 500
+ })
+ });
+
+ it('should return default adapterOptions if not set', function () {
+ config.setConfig({
+ s2sConfig: {
+ accountId: '1234',
+ bidders: ['pubmatic'],
+ defaultVendor: 'openwrap',
+ timeout: 500
+ }
+ });
+ expect(config.getConfig('s2sConfig')).to.deep.equal({
+ enabled: true,
+ timeout: 500,
+ adapter: 'prebidServer',
+ accountId: '1234',
+ bidders: ['pubmatic'],
+ defaultVendor: 'openwrap',
+ endpoint: {
+ p1Consent: 'https://ow.pubmatic.com/openrtb2/auction?source=pbjs',
+ noP1Consent: 'https://ow.pubmatic.com/openrtb2/auction?source=pbjs'
+ },
+ })
+ });
+
it('should set adapterOptions', function () {
config.setConfig({
s2sConfig: {
diff --git a/test/spec/modules/precisoBidAdapter_spec.js b/test/spec/modules/precisoBidAdapter_spec.js
index db38845c11a..78a1615a02e 100644
--- a/test/spec/modules/precisoBidAdapter_spec.js
+++ b/test/spec/modules/precisoBidAdapter_spec.js
@@ -1,5 +1,5 @@
-import {expect} from 'chai';
-import {spec} from '../../../modules/precisoBidAdapter.js';
+import { expect } from 'chai';
+import { spec } from '../../../modules/precisoBidAdapter.js';
import { config } from '../../../src/config.js';
const DEFAULT_PRICE = 1
@@ -10,17 +10,27 @@ const BIDDER_CODE = 'preciso';
describe('PrecisoAdapter', function () {
let bid = {
-
bidId: '23fhj33i987f',
bidder: 'preciso',
+ mediaTypes: {
+ banner: {
+ sizes: [[DEFAULT_BANNER_WIDTH, DEFAULT_BANNER_HEIGHT]]
+ }
+ },
params: {
host: 'prebid',
sourceid: '0',
publisherId: '0',
- traffic: 'banner',
+ mediaType: 'banner',
region: 'prebid-eu'
- }
+ },
+ userId: {
+ pubcid: '12355454test'
+
+ },
+ geo: 'NA',
+ city: 'Asia,delhi'
};
describe('isBidRequestValid', function () {
@@ -49,35 +59,37 @@ describe('PrecisoAdapter', function () {
});
it('Returns valid data if array of bids is valid', function () {
let data = serverRequest.data;
- expect(data).to.be.an('object');
- expect(data).to.have.all.keys('id', 'imp', 'site', 'deviceWidth', 'deviceHeight', 'language', 'secure', 'host', 'page', 'placements', 'coppa');
+ // expect(data).to.be.an('object');
+
+ // expect(data).to.have.all.keys('bidId', 'imp', 'site', 'deviceWidth', 'deviceHeight', 'language', 'secure', 'host', 'page', 'placements', 'coppa');
+
expect(data.deviceWidth).to.be.a('number');
expect(data.deviceHeight).to.be.a('number');
expect(data.coppa).to.be.a('number');
expect(data.language).to.be.a('string');
- expect(data.secure).to.be.within(0, 1);
+ // expect(data.secure).to.be.within(0, 1);
expect(data.host).to.be.a('string');
expect(data.page).to.be.a('string');
- let placement = data['placements'][0];
- expect(placement).to.have.keys('region', 'bidId', 'traffic', 'sizes', 'publisherId');
- expect(placement.bidId).to.equal('23fhj33i987f');
- expect(placement.traffic).to.equal('banner');
- expect(placement.region).to.equal('prebid-eu');
- });
- it('Returns empty data if no valid requests are passed', function () {
- serverRequest = spec.buildRequests([]);
- let data = serverRequest.data;
- expect(data.placements).to.be.an('array').that.is.empty;
+
+ expect(data.city).to.be.a('string');
+ expect(data.geo).to.be.a('object');
+ // expect(data.userId).to.be.a('string');
+ // expect(data.imp).to.be.a('object');
});
+ // it('Returns empty data if no valid requests are passed', function () {
+ /// serverRequest = spec.buildRequests([]);
+ // let data = serverRequest.data;
+ // expect(data.imp).to.be.an('array').that.is.empty;
+ // });
});
- describe('with COPPA', function() {
- beforeEach(function() {
+ describe('with COPPA', function () {
+ beforeEach(function () {
sinon.stub(config, 'getConfig')
.withArgs('coppa')
.returns(true);
});
- afterEach(function() {
+ afterEach(function () {
config.getConfig.restore();
});
@@ -90,7 +102,9 @@ describe('PrecisoAdapter', function () {
describe('interpretResponse', function () {
it('should get correct bid response', function () {
let response = {
- id: 'f6adb85f-4e19-45a0-b41e-2a5b9a48f23a',
+
+ bidderRequestId: 'f6adb85f-4e19-45a0-b41e-2a5b9a48f23a',
+
seatbid: [
{
bid: [
@@ -131,7 +145,7 @@ describe('PrecisoAdapter', function () {
})
})
describe('getUserSyncs', function () {
- const syncUrl = 'https://ck.2trk.info/rtb/user/usersync.aspx?id=preciso_srl&gdpr=0&gdpr_consent=&us_privacy=&t=4';
+ const syncUrl = 'https://ck.2trk.info/rtb/user/usersync.aspx?id=NA&gdpr=0&gdpr_consent=&us_privacy=&t=4';
const syncOptions = {
iframeEnabled: true
};
diff --git a/test/spec/modules/priceFloors_spec.js b/test/spec/modules/priceFloors_spec.js
index e2b8ca38792..a31f07fecef 100644
--- a/test/spec/modules/priceFloors_spec.js
+++ b/test/spec/modules/priceFloors_spec.js
@@ -12,7 +12,7 @@ import {
isFloorsDataValid,
addBidResponseHook,
fieldMatchingFunctions,
- allowedFields
+ allowedFields, parseFloorData, normalizeDefault, getFloorDataFromAdUnits, updateAdUnitsForAuction, createFloorsDataForAuction
} from 'modules/priceFloors.js';
import * as events from 'src/events.js';
import * as mockGpt from '../integration/faker/googletag.js';
@@ -123,7 +123,7 @@ describe('the price floors module', function () {
return {
code,
mediaTypes: {banner: { sizes: [[300, 200], [300, 600]] }, native: {}},
- bids: [{bidder: 'someBidder'}, {bidder: 'someOtherBidder'}]
+ bids: [{bidder: 'someBidder', adUnitCode: code}, {bidder: 'someOtherBidder', adUnitCode: code}]
};
}
beforeEach(function() {
@@ -143,6 +143,76 @@ describe('the price floors module', function () {
getGlobal().bidderSettings = {};
});
+ describe('parseFloorData', () => {
+ it('should accept just a default floor', () => {
+ const fd = parseFloorData({
+ default: 1.23
+ });
+ expect(getFirstMatchingFloor(fd, {}, {}).matchingFloor).to.eql(1.23);
+ });
+ });
+
+ describe('getFloorDataFromAdUnits', () => {
+ let adUnits;
+
+ function setFloorValues(rule) {
+ adUnits.forEach((au, i) => {
+ au.floors = {
+ values: {
+ [rule]: i + 1
+ }
+ }
+ })
+ }
+
+ beforeEach(() => {
+ adUnits = ['au1', 'au2', 'au3'].map(getAdUnitMock);
+ })
+
+ it('should use one schema for all adUnits', () => {
+ setFloorValues('*;*')
+ adUnits[1].floors.schema = {
+ fields: ['mediaType', 'gptSlot'],
+ delimiter: ';'
+ }
+ sinon.assert.match(getFloorDataFromAdUnits(adUnits), {
+ schema: {
+ fields: ['adUnitCode', 'mediaType', 'gptSlot'],
+ delimiter: ';'
+ },
+ values: {
+ 'au1;*;*': 1,
+ 'au2;*;*': 2,
+ 'au3;*;*': 3
+ }
+ })
+ });
+ it('should ignore adUnits that declare different schema', () => {
+ setFloorValues('*|*');
+ adUnits[0].floors.schema = {
+ fields: ['mediaType', 'gptSlot']
+ };
+ adUnits[2].floors.schema = {
+ fields: ['gptSlot', 'mediaType']
+ };
+ expect(getFloorDataFromAdUnits(adUnits).values).to.eql({
+ 'au1|*|*': 1,
+ 'au2|*|*': 2
+ })
+ });
+ it('should ignore adUnits that declare no values', () => {
+ setFloorValues('*');
+ adUnits[0].floors.schema = {
+ fields: ['mediaType']
+ };
+ delete adUnits[2].floors.values;
+ expect(getFloorDataFromAdUnits(adUnits).values).to.eql({
+ 'au1|*': 1,
+ 'au2|*': 2,
+ })
+ })
+ })
+
describe('getFloorsDataForAuction', function () {
it('converts basic input floor data into a floorData map for the auction correctly', function () {
// basic input where nothing needs to be updated
@@ -233,8 +303,8 @@ describe('the price floors module', function () {
});
describe('getFirstMatchingFloor', function () {
- it('uses a 0 floor as overrite', function () {
- let inputFloorData = {
+ it('uses a 0 floor as override', function () {
+ let inputFloorData = normalizeDefault({
currency: 'USD',
schema: {
delimiter: '|',
@@ -245,7 +315,7 @@ describe('the price floors module', function () {
'test_div_2': 2
},
default: 0.5
- };
+ });
expect(getFirstMatchingFloor(inputFloorData, basicBidRequest, {mediaType: 'banner', size: '*'})).to.deep.equal({
floorMin: 0,
@@ -434,7 +504,7 @@ describe('the price floors module', function () {
});
});
it('selects the right floor for more complex rules', function () {
- let inputFloorData = {
+ let inputFloorData = normalizeDefault({
currency: 'USD',
schema: {
delimiter: '^',
@@ -448,7 +518,7 @@ describe('the price floors module', function () {
'weird_div^*^300x250': 5.5
},
default: 0.5
- };
+ });
// banner with 300x250 size
expect(getFirstMatchingFloor(inputFloorData, basicBidRequest, {mediaType: 'banner', size: [300, 250]})).to.deep.equal({
floorMin: 0,
@@ -490,10 +560,8 @@ describe('the price floors module', function () {
matchingFloor: undefined
});
// if default is there use it
- inputFloorData = { default: 5.0 };
- expect(getFirstMatchingFloor(inputFloorData, basicBidRequest, {mediaType: 'banner', size: '*'})).to.deep.equal({
- matchingFloor: 5.0
- });
+ inputFloorData = normalizeDefault({ default: 5.0 });
+ expect(getFirstMatchingFloor(inputFloorData, basicBidRequest, {mediaType: 'banner', size: '*'}).matchingFloor).to.equal(5.0);
});
describe('with gpt enabled', function () {
let gptFloorData;
@@ -580,6 +648,90 @@ describe('the price floors module', function () {
});
});
});
+
+ describe('updateAdUnitsForAuction', function() {
+ let inputFloorData;
+ let adUnits;
+
+ beforeEach(function() {
+ adUnits = [getAdUnitMock()];
+ inputFloorData = utils.deepClone(minFloorConfigLow);
+ inputFloorData.skipRate = 0.5;
+ });
+
+ it('should set the skipRate to the skipRate from the data property before using the skipRate from floorData directly', function() {
+ utils.deepSetValue(inputFloorData, 'data', {
+ skipRate: 0.7
+ });
+ updateAdUnitsForAuction(adUnits, inputFloorData, 'id');
+
+ const skipRate = utils.deepAccess(adUnits, '0.bids.0.floorData.skipRate');
+ expect(skipRate).to.equal(0.7);
+ });
+
+ it('should set the skipRate to the skipRate from floorData directly if it does not exist in the data property of floorData', function() {
+ updateAdUnitsForAuction(adUnits, inputFloorData, 'id');
+
+ const skipRate = utils.deepAccess(adUnits, '0.bids.0.floorData.skipRate');
+ expect(skipRate).to.equal(0.5);
+ });
+
+ it('should set the skipRate in the bid floorData to undefined if both skipRate and skipRate in the data property are undefined', function() {
+ inputFloorData.skipRate = undefined;
+ utils.deepSetValue(inputFloorData, 'data', {
+ skipRate: undefined,
+ });
+ updateAdUnitsForAuction(adUnits, inputFloorData, 'id');
+
+ const skipRate = utils.deepAccess(adUnits, '0.bids.0.floorData.skipRate');
+ expect(skipRate).to.equal(undefined);
+ });
+ });
+
+ describe('createFloorsDataForAuction', function() {
+ let adUnits;
+ let floorConfig;
+
+ beforeEach(function() {
+ adUnits = [getAdUnitMock()];
+ floorConfig = utils.deepClone(basicFloorConfig);
+ });
+
+ it('should return skipRate as 0 if both skipRate and skipRate in the data property are undefined', function() {
+ floorConfig.skipRate = undefined;
+ floorConfig.data.skipRate = undefined;
+ handleSetFloorsConfig(floorConfig);
+
+ const floorData = createFloorsDataForAuction(adUnits, 'id');
+
+ expect(floorData.skipRate).to.equal(0);
+ expect(floorData.skipped).to.equal(false);
+ });
+
+ it('should properly set skipRate if it is available in the data property', function() {
+ // this will force skipped to be true
+ floorConfig.skipRate = 101;
+ floorConfig.data.skipRate = 201;
+ handleSetFloorsConfig(floorConfig);
+
+ const floorData = createFloorsDataForAuction(adUnits, 'id');
+
+ expect(floorData.data.skipRate).to.equal(201);
+ expect(floorData.skipped).to.equal(true);
+ });
+
+ it('should should use the skipRate if its not available in the data property ', function() {
+ // this will force skipped to be true
+ floorConfig.skipRate = 101;
+ handleSetFloorsConfig(floorConfig);
+
+ const floorData = createFloorsDataForAuction(adUnits, 'id');
+
+ expect(floorData.skipRate).to.equal(101);
+ expect(floorData.skipped).to.equal(true);
+ });
+ });
+
describe('pre-auction tests', function () {
let exposedAdUnits;
const validateBidRequests = (getFloorExpected, FloorDataExpected) => {
@@ -621,6 +773,124 @@ describe('the price floors module', function () {
floorProvider: undefined
});
});
+ it('should not do floor stuff if floors.data is defined by noFloorSignalBidders[]', function() {
+ handleSetFloorsConfig({
+ ...basicFloorConfig,
+ data: {
+ ...basicFloorDataLow,
+ noFloorSignalBidders: ['someBidder', 'someOtherBidder']
+ }});
+ runStandardAuction();
+ validateBidRequests(false, {
+ skipped: false,
+ floorMin: undefined,
+ modelVersion: 'basic model',
+ modelWeight: 10,
+ modelTimestamp: undefined,
+ location: 'setConfig',
+ skipRate: 0,
+ fetchStatus: undefined,
+ floorProvider: undefined,
+ noFloorSignaled: true
+ })
+ });
+ it('should not do floor stuff if floors.enforcement is defined by noFloorSignalBidders[]', function() {
+ handleSetFloorsConfig({ ...basicFloorConfig,
+ enforcement: {
+ enforceJS: true,
+ noFloorSignalBidders: ['someBidder', 'someOtherBidder']
+ },
+ data: basicFloorDataLow
+ });
+ runStandardAuction();
+ validateBidRequests(false, {
+ skipped: false,
+ floorMin: undefined,
+ modelVersion: 'basic model',
+ modelWeight: 10,
+ modelTimestamp: undefined,
+ location: 'setConfig',
+ skipRate: 0,
+ fetchStatus: undefined,
+ floorProvider: undefined,
+ noFloorSignaled: true
+ })
+ });
+ it('should not do floor stuff and use first floors.data.noFloorSignalBidders if its defined betwen enforcement.noFloorSignalBidders', function() {
+ handleSetFloorsConfig({ ...basicFloorConfig,
+ enforcement: {
+ enforceJS: true,
+ noFloorSignalBidders: ['someBidder']
+ },
+ data: {
+ ...basicFloorDataLow,
+ noFloorSignalBidders: ['someBidder', 'someOtherBidder']
+ }
+ });
+ runStandardAuction();
+ validateBidRequests(false, {
+ skipped: false,
+ floorMin: undefined,
+ modelVersion: 'basic model',
+ modelWeight: 10,
+ modelTimestamp: undefined,
+ location: 'setConfig',
+ skipRate: 0,
+ fetchStatus: undefined,
+ floorProvider: undefined,
+ noFloorSignaled: true
+ })
+ });
+ it('it shouldn`t return floor stuff for bidder in the noFloorSignalBidders list', function() {
+ handleSetFloorsConfig({ ...basicFloorConfig,
+ enforcement: {
+ enforceJS: true,
+ },
+ data: {
+ ...basicFloorDataLow,
+ noFloorSignalBidders: ['someBidder']
+ }
+ });
+ runStandardAuction()
+ const bidRequestData = exposedAdUnits[0].bids.find(bid => bid.bidder === 'someBidder');
+ expect(bidRequestData.hasOwnProperty('getFloor')).to.equal(false);
+ sinon.assert.match(bidRequestData.floorData, {
+ skipped: false,
+ floorMin: undefined,
+ modelVersion: 'basic model',
+ modelWeight: 10,
+ modelTimestamp: undefined,
+ location: 'setConfig',
+ skipRate: 0,
+ fetchStatus: undefined,
+ floorProvider: undefined,
+ noFloorSignaled: true
+ });
+ })
+ it('it should return floor stuff if we defined wrong bidder name in data.noFloorSignalBidders', function() {
+ handleSetFloorsConfig({ ...basicFloorConfig,
+ enforcement: {
+ enforceJS: true,
+ },
+ data: {
+ ...basicFloorDataLow,
+ noFloorSignalBidders: ['randomBiider']
+ }
+ });
+ runStandardAuction();
+ validateBidRequests(true, {
+ skipped: false,
+ floorMin: undefined,
+ modelVersion: 'basic model',
+ modelWeight: 10,
+ modelTimestamp: undefined,
+ location: 'setConfig',
+ skipRate: 0,
+ fetchStatus: undefined,
+ floorProvider: undefined,
+ noFloorSignaled: false
+ })
+ });
it('should use adUnit level data if not setConfig or fetch has occured', function () {
handleSetFloorsConfig({
...basicFloorConfig,
@@ -693,6 +963,95 @@ describe('the price floors module', function () {
floorProvider: undefined
});
});
+ describe('default floor', () => {
+ let adUnits;
+ beforeEach(() => {
+ adUnits = ['au1', 'au2'].map(getAdUnitMock);
+ })
+ function expectFloors(floors) {
+ runStandardAuction(adUnits);
+ adUnits.forEach((au, i) => {
+ au.bids.forEach(bid => {
+ expect(bid.getFloor().floor).to.eql(floors[i]);
+ })
+ })
+ }
+ describe('should be sufficient by itself', () => {
+ it('globally', () => {
+ handleSetFloorsConfig({
+ ...basicFloorConfig,
+ data: {
+ default: 1.23
+ }
+ });
+ expectFloors([1.23, 1.23])
+ });
+ it('on adUnits', () => {
+ handleSetFloorsConfig({
+ ...basicFloorConfig,
+ data: undefined
+ });
+ adUnits[0].floors = {default: 1};
+ adUnits[1].floors = {default: 2};
+ expectFloors([1, 2])
+ });
+ it('on an adUnit with hidden schema', () => {
+ handleSetFloorsConfig({
+ ...basicFloorConfig,
+ data: undefined
+ });
+ adUnits[0].floors = {
+ schema: {
+ fields: ['mediaType', 'gptSlot'],
+ },
+ default: 1
+ }
+ adUnits[1].floors = {
+ default: 2
+ }
+ expectFloors([1, 2]);
+ })
+ });
+ describe('should NOT be used when a star rule exists', () => {
+ it('globally', () => {
+ handleSetFloorsConfig({
+ ...basicFloorConfig,
+ data: {
+ schema: {
+ fields: ['mediaType', 'gptSlot'],
+ },
+ values: {
+ '*|*': 2
+ },
+ default: 3,
+ }
+ });
+ expectFloors([2, 2]);
+ });
+ it('on adUnits', () => {
+ handleSetFloorsConfig({
+ ...basicFloorConfig,
+ data: undefined
+ });
+ adUnits[0].floors = {
+ schema: {
+ fields: ['mediaType', 'gptSlot'],
+ },
+ values: {
+ '*|*': 1
+ },
+ default: 3
+ };
+ adUnits[1].floors = {
+ values: {
+ '*|*': 2
+ },
+ default: 4
+ }
+ expectFloors([1, 2]);
+ })
+ });
+ })
it('bidRequests should have getFloor function and flooring meta data when setConfig occurs', function () {
handleSetFloorsConfig({...basicFloorConfig, floorProvider: 'floorprovider'});
runStandardAuction();
@@ -1382,7 +1741,7 @@ describe('the price floors module', function () {
it('picks the right rule with more complex rules', function () {
_floorDataForAuction[bidRequest.auctionId] = {
...basicFloorConfig,
- data: {
+ data: normalizeDefault({
currency: 'USD',
schema: { fields: ['mediaType', 'size'], delimiter: '|' },
values: {
@@ -1394,7 +1753,7 @@ describe('the price floors module', function () {
'video|*': 5.5
},
default: 10.0
- }
+ })
};
// assumes banner *
@@ -1854,6 +2213,12 @@ describe('the price floors module', function () {
expect(returnedBidResponse).to.not.haveOwnProperty('floorData');
expect(logWarnSpy.calledOnce).to.equal(true);
});
+ it('if it finds a rule with a floor price of zero it should not call log warn', function () {
+ _floorDataForAuction[AUCTION_ID] = utils.deepClone(basicFloorConfig);
+ _floorDataForAuction[AUCTION_ID].data.values = { '*': 0 };
+ runBidResponse();
+ expect(logWarnSpy.calledOnce).to.equal(false);
+ });
it('if it finds a rule and floors should update the bid accordingly', function () {
_floorDataForAuction[AUCTION_ID] = utils.deepClone(basicFloorConfig);
_floorDataForAuction[AUCTION_ID].data.values = { 'banner': 1.0 };
diff --git a/test/spec/modules/programmaticaBidAdapter_spec.js b/test/spec/modules/programmaticaBidAdapter_spec.js
new file mode 100644
index 00000000000..247d20752c3
--- /dev/null
+++ b/test/spec/modules/programmaticaBidAdapter_spec.js
@@ -0,0 +1,263 @@
+import { expect } from 'chai';
+import { spec } from 'modules/programmaticaBidAdapter.js';
+import { deepClone } from 'src/utils.js';
+
+describe('programmaticaBidAdapterTests', function () {
+ let bidRequestData = {
+ bids: [
+ {
+ bidId: 'testbid',
+ bidder: 'programmatica',
+ params: {
+ siteId: 'testsite',
+ placementId: 'testplacement',
+ },
+ sizes: [[300, 250]]
+ }
+ ]
+ };
+ let request = [];
+
+ it('validate_pub_params', function () {
+ expect(
+ spec.isBidRequestValid({
+ bidder: 'programmatica',
+ params: {
+ siteId: 'testsite',
+ placementId: 'testplacement',
+ }
+ })
+ ).to.equal(true);
+ });
+
+ it('validate_generated_url', function () {
+ const request = spec.buildRequests(deepClone(bidRequestData.bids), { timeout: 1234 });
+ let req_url = request[0].url;
+
+ expect(req_url).to.equal('https://asr.programmatica.com/get');
+ });
+
+ it('validate_response_params', function () {
+ let serverResponse = {
+ body: {
+ 'id': 'crid',
+ 'type': {
+ 'format': 'Image',
+ 'source': 'passback',
+ 'dspId': '',
+ 'dspCreativeId': ''
+ },
+ 'content': {
+ 'data': 'test ad',
+ 'imps': null,
+ 'click': {
+ 'url': '',
+ 'track': null
+ }
+ },
+ 'size': '300x250',
+ 'matching': '',
+ 'cpm': 10,
+ 'currency': 'USD'
+ }
+ };
+
+ const bidRequest = deepClone(bidRequestData.bids)
+ bidRequest[0].mediaTypes = {
+ banner: {}
+ }
+
+ const request = spec.buildRequests(bidRequest);
+ 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(10);
+ expect(bid.currency).to.equal('USD');
+ expect(bid.width).to.equal(300);
+ expect(bid.height).to.equal(250);
+ expect(bid.creativeId).to.equal('crid');
+ expect(bid.meta.advertiserDomains).to.deep.equal(['programmatica.com']);
+ });
+
+ it('validate_response_params_imps', function () {
+ let serverResponse = {
+ body: {
+ 'id': 'crid',
+ 'type': {
+ 'format': 'Image',
+ 'source': 'passback',
+ 'dspId': '',
+ 'dspCreativeId': ''
+ },
+ 'content': {
+ 'data': 'test ad',
+ 'imps': [
+ 'testImp'
+ ],
+ 'click': {
+ 'url': '',
+ 'track': null
+ }
+ },
+ 'size': '300x250',
+ 'matching': '',
+ 'cpm': 10,
+ 'currency': 'USD'
+ }
+ };
+
+ const bidRequest = deepClone(bidRequestData.bids)
+ bidRequest[0].mediaTypes = {
+ banner: {}
+ }
+
+ const request = spec.buildRequests(bidRequest);
+ 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(10);
+ expect(bid.currency).to.equal('USD');
+ expect(bid.width).to.equal(300);
+ expect(bid.height).to.equal(250);
+ expect(bid.creativeId).to.equal('crid');
+ expect(bid.meta.advertiserDomains).to.deep.equal(['programmatica.com']);
+ })
+
+ it('validate_invalid_response', function () {
+ let serverResponse = {
+ body: {}
+ };
+
+ const bidRequest = deepClone(bidRequestData.bids)
+ bidRequest[0].mediaTypes = {
+ banner: {}
+ }
+
+ const request = spec.buildRequests(bidRequest);
+ let bids = spec.interpretResponse(serverResponse, request[0]);
+ expect(bids).to.have.lengthOf(0);
+ })
+
+ it('video_bid', function () {
+ const bidRequest = deepClone(bidRequestData.bids);
+ bidRequest[0].mediaTypes = {
+ video: {
+ playerSize: [234, 765]
+ }
+ };
+
+ const request = spec.buildRequests(bidRequest, { timeout: 1234 });
+ const vastXml = 'vast ' }, {index: stubAuctionIndex({adUnits})});
+ it('catches invalid instream bids', function () {
+ const bid = {
+ transactionId: 'au'
+ };
+ const adUnits = [{
+ transactionId: 'au',
+ mediaTypes: {
+ video: {context: 'instream'}
+ }
+ }];
+ const valid = isValidVideoBid(bid, {index: stubAuctionIndex({adUnits})});
+ expect(valid).to.equal(false);
+ });
- expect(valid).to.equal(false);
- });
+ it('catches invalid bids when prebid-cache is disabled', function () {
+ const adUnits = [{
+ transactionId: 'au',
+ bidder: 'vastOnlyVideoBidder',
+ mediaTypes: {video: {}},
+ }];
- it('validates valid outstream bids', function () {
- const bid = {
- transactionId: 'au',
- renderer: {
- url: 'render.url',
- render: () => true,
- }
- };
- const adUnits = [{
- transactionId: 'au',
- mediaTypes: {
- video: {context: 'outstream'}
- }
- }];
- const valid = isValidVideoBid(bid, {index: stubAuctionIndex({adUnits})});
- expect(valid).to.equal(true);
- });
+ const valid = isValidVideoBid({ transactionId: 'au', vastXml: 'vast ' }, {index: stubAuctionIndex({adUnits})});
- it('validates valid outstream bids with a publisher defined renderer', function () {
- const bid = {
- transactionId: 'au',
- };
- const adUnits = [{
- transactionId: 'au',
- mediaTypes: {
- video: {
- context: 'outstream',
+ expect(valid).to.equal(false);
+ });
+
+ it('validates valid outstream bids', function () {
+ const bid = {
+ transactionId: 'au',
+ renderer: {
+ url: 'render.url',
+ render: () => true,
}
- },
- renderer: {
- url: 'render.url',
- render: () => true,
- }
- }];
- const valid = isValidVideoBid(bid, {index: stubAuctionIndex({adUnits})});
- expect(valid).to.equal(true);
- });
+ };
+ const adUnits = [{
+ transactionId: 'au',
+ mediaTypes: {
+ video: {context: 'outstream'}
+ }
+ }];
+ const valid = isValidVideoBid(bid, {index: stubAuctionIndex({adUnits})});
+ expect(valid).to.equal(true);
+ });
- it('catches invalid outstream bids', function () {
- const bid = {
- transactionId: 'au',
- };
- const adUnits = [{
- transactionId: 'au',
- mediaTypes: {
- video: {context: 'outstream'}
- }
- }];
- const valid = isValidVideoBid(bid, {index: stubAuctionIndex({adUnits})});
- expect(valid).to.equal(false);
- });
+ it('validates valid outstream bids with a publisher defined renderer', function () {
+ const bid = {
+ transactionId: 'au',
+ };
+ const adUnits = [{
+ transactionId: 'au',
+ mediaTypes: {
+ video: {
+ context: 'outstream',
+ }
+ },
+ renderer: {
+ url: 'render.url',
+ render: () => true,
+ }
+ }];
+ const valid = isValidVideoBid(bid, {index: stubAuctionIndex({adUnits})});
+ expect(valid).to.equal(true);
+ });
+
+ it('catches invalid outstream bids', function () {
+ const bid = {
+ transactionId: 'au',
+ };
+ const adUnits = [{
+ transactionId: 'au',
+ mediaTypes: {
+ video: {context: 'outstream'}
+ }
+ }];
+ const valid = isValidVideoBid(bid, {index: stubAuctionIndex({adUnits})});
+ expect(valid).to.equal(false);
+ });
+ })
});
diff --git a/test/test_deps.js b/test/test_deps.js
index 35713106f8c..c8a3bcc9426 100644
--- a/test/test_deps.js
+++ b/test/test_deps.js
@@ -4,6 +4,16 @@ window.process = {
}
};
+window.addEventListener('error', function (ev) {
+ // eslint-disable-next-line no-console
+ console.error('Uncaught exception:', ev.error, ev.error?.stack);
+})
+
+window.addEventListener('unhandledrejection', function (ev) {
+ // eslint-disable-next-line no-console
+ console.error('Unhandled rejection:', ev.reason);
+})
+
require('test/helpers/consentData.js');
require('test/helpers/prebidGlobal.js');
require('test/mocks/adloaderStub.js');
diff --git a/webpack.creative.js b/webpack.creative.js
new file mode 100644
index 00000000000..7279455e155
--- /dev/null
+++ b/webpack.creative.js
@@ -0,0 +1,19 @@
+const path = require('path');
+
+module.exports = {
+ mode: 'production',
+ resolve: {
+ modules: [
+ path.resolve('.'),
+ 'node_modules'
+ ],
+ },
+ entry: {
+ 'creative': {
+ import: './libraries/creativeRender/crossDomain.js',
+ },
+ },
+ output: {
+ path: path.resolve('./build/creative'),
+ },
+}
+
+
+ ]]>
+
+
+ I am an ad
', + ttl: 30, + creativeId: 'div-1', + netRevenue: false, + bidderCode: '123', + dealId: 232, + requestId: '123', + meta: { + brandId: null, + advertiserDomains: ['https://dai.doceree.com/drs/quest'], + }, + }, + }; + let bannerResponses = spec.interpretResponse(banner); + expect(bannerResponses).to.be.an('array').that.is.not.empty; + let dataItem = bannerResponses[0]; + expect(dataItem).to.have.all.keys( + 'requestId', + 'cpm', + 'width', + 'height', + 'ad', + 'ttl', + 'netRevenue', + 'currency', + 'mediaType', + 'creativeId', + 'meta' + ); + expect(dataItem.requestId).to.equal('123'); + expect(dataItem.cpm).to.equal(3.576); + expect(dataItem.width).to.equal(250); + expect(dataItem.height).to.equal(300); + expect(dataItem.ad).to.equal('I am an ad
'); + expect(dataItem.ttl).to.equal(30); + expect(dataItem.netRevenue).to.be.true; + expect(dataItem.currency).to.equal('USD'); + expect(dataItem.creativeId).to.equal('div-1'); + expect(dataItem.meta.advertiserDomains).to.be.an('array').that.is.not + .empty; + }); + }); +}); diff --git a/test/spec/modules/docereeBidAdapter_spec.js b/test/spec/modules/docereeBidAdapter_spec.js index dadbb56b0c0..25da8b256fc 100644 --- a/test/spec/modules/docereeBidAdapter_spec.js +++ b/test/spec/modules/docereeBidAdapter_spec.js @@ -1,6 +1,7 @@ import {expect} from 'chai'; import {spec} from '../../../modules/docereeBidAdapter.js'; import { config } from '../../../src/config.js'; +import * as utils from 'src/utils.js'; describe('BidlabBidAdapter', function () { config.setConfig({ @@ -102,4 +103,36 @@ describe('BidlabBidAdapter', function () { expect(dataItem.meta.advertiserDomains[0]).to.equal('doceree.com') }); }) + describe('onBidWon', function () { + beforeEach(function() { + sinon.stub(utils, 'triggerPixel'); + }); + afterEach(function() { + utils.triggerPixel.restore(); + }); + it('exists and is a function', () => { + expect(spec.onBidWon).to.exist.and.to.be.a('function'); + }); + it('should return nothing', function () { + var response = spec.onBidWon({}); + expect(response).to.be.an('undefined') + expect(utils.triggerPixel.called).to.equal(true); + }); + }); + describe('onTimeout', function () { + beforeEach(function() { + sinon.stub(utils, 'triggerPixel'); + }); + afterEach(function() { + utils.triggerPixel.restore(); + }); + it('exists and is a function', () => { + expect(spec.onTimeout).to.exist.and.to.be.a('function'); + }); + it('should return nothing', function () { + var response = spec.onBidWon([]); + expect(response).to.be.an('undefined') + expect(utils.triggerPixel.called).to.equal(true); + }); + }); }); diff --git a/test/spec/modules/dsp_genieeBidAdapter_spec.js b/test/spec/modules/dsp_genieeBidAdapter_spec.js new file mode 100644 index 00000000000..94ec1011fbf --- /dev/null +++ b/test/spec/modules/dsp_genieeBidAdapter_spec.js @@ -0,0 +1,173 @@ +import { expect } from 'chai'; +import { spec } from 'modules/dsp_genieeBidAdapter.js'; +import { config } from 'src/config'; + +describe('Geniee adapter tests', () => { + const validBidderRequest = { + code: 'sample_request', + bids: [{ + bidId: 'bid-id', + bidder: 'dsp_geniee', + params: { + test: 1 + } + }], + gdprConsent: { + gdprApplies: false + }, + uspConsent: '1YNY' + }; + + describe('isBidRequestValid function test', () => { + it('valid', () => { + expect(spec.isBidRequestValid(validBidderRequest.bids[0])).equal(true); + }); + }); + describe('buildRequests function test', () => { + it('auction', () => { + const request = spec.buildRequests(validBidderRequest.bids, validBidderRequest); + const auction_id = request.data.id; + expect(request).deep.equal({ + method: 'POST', + url: 'https://rt.gsspat.jp/prebid_auction', + data: { + at: 1, + id: auction_id, + imp: [ + { + ext: { + test: 1 + }, + id: 'bid-id' + } + ], + test: 1 + }, + }); + }); + it('uncomfortable (gdpr)', () => { + validBidderRequest.gdprConsent.gdprApplies = true; + const request = spec.buildRequests(validBidderRequest.bids, validBidderRequest); + expect(request).deep.equal({ + method: 'GET', + url: 'https://rt.gsspat.jp/prebid_uncomfortable', + }); + validBidderRequest.gdprConsent.gdprApplies = false; + }); + it('uncomfortable (usp)', () => { + validBidderRequest.uspConsent = '1YYY'; + const request = spec.buildRequests(validBidderRequest.bids, validBidderRequest); + expect(request).deep.equal({ + method: 'GET', + url: 'https://rt.gsspat.jp/prebid_uncomfortable', + }); + validBidderRequest.uspConsent = '1YNY'; + }); + it('uncomfortable (coppa)', () => { + config.setConfig({ coppa: true }); + const request = spec.buildRequests(validBidderRequest.bids, validBidderRequest); + expect(request).deep.equal({ + method: 'GET', + url: 'https://rt.gsspat.jp/prebid_uncomfortable', + }); + config.resetConfig(); + }); + it('uncomfortable (currency)', () => { + config.setConfig({ currency: { adServerCurrency: 'TWD' } }); + const request = spec.buildRequests(validBidderRequest.bids, validBidderRequest); + expect(request).deep.equal({ + method: 'GET', + url: 'https://rt.gsspat.jp/prebid_uncomfortable', + }); + config.resetConfig(); + }); + }); + describe('interpretResponse function test', () => { + it('sample bid', () => { + const request = spec.buildRequests(validBidderRequest.bids, validBidderRequest); + const auction_id = request.data.id; + const adm = "\n"; + const serverResponse = { + body: { + id: auction_id, + cur: 'JPY', + seatbid: [{ + bid: [{ + id: '7b77235d599e06d289e58ddfa9390443e22d7071', + impid: 'bid-id', + price: 0.6666000000000001, + adid: '8405715', + adm: adm, + adomain: ['geniee.co.jp'], + iurl: 'http://img.gsspat.jp/e/068c8e1eafbf0cb6ac1ee95c36152bd2/04f4bd4e6b71f978d343d84ecede3877.png', + cid: '8405715', + crid: '1383823', + cat: ['IAB1'], + w: 300, + h: 250, + mtype: 1 + }] + }] + } + }; + const bids = spec.interpretResponse(serverResponse, request); + expect(bids).deep.equal([{ + ad: adm, + cpm: 0.6666000000000001, + creativeId: '1383823', + creative_id: '1383823', + height: 250, + width: 300, + currency: 'JPY', + mediaType: 'banner', + meta: { + advertiserDomains: ['geniee.co.jp'] + }, + netRevenue: true, + requestId: 'bid-id', + seatBidId: '7b77235d599e06d289e58ddfa9390443e22d7071', + ttl: 300 + }]); + }); + it('no bid', () => { + const serverResponse = {}; + const bids = spec.interpretResponse(serverResponse, validBidderRequest); + expect(bids).deep.equal([]); + }); + }); + describe('getUserSyncs function test', () => { + it('sync enabled', () => { + const syncOptions = { + iframeEnabled: true, + pixelEnabled: true + }; + const serverResponses = []; + const syncs = spec.getUserSyncs(syncOptions, serverResponses); + expect(syncs).deep.equal([{ + type: 'image', + url: 'https://rt.gsspat.jp/prebid_cs' + }]); + }); + it('sync disabled (option false)', () => { + const syncOptions = { + iframeEnabled: false, + pixelEnabled: false + }; + const serverResponses = []; + const syncs = spec.getUserSyncs(syncOptions, serverResponses); + expect(syncs).deep.equal([]); + }); + it('sync disabled (gdpr)', () => { + const syncOptions = { + iframeEnabled: true, + pixelEnabled: true + }; + const serverResponses = []; + const gdprConsent = { + gdprApplies: true + }; + const syncs = spec.getUserSyncs(syncOptions, serverResponses, gdprConsent); + expect(syncs).deep.equal([]); + }); + }); +}); diff --git a/test/spec/modules/dxkultureBidAdapter_spec.js b/test/spec/modules/dxkultureBidAdapter_spec.js new file mode 100644 index 00000000000..a752c81cb6e --- /dev/null +++ b/test/spec/modules/dxkultureBidAdapter_spec.js @@ -0,0 +1,649 @@ +import {expect} from 'chai'; +import {spec, SYNC_URL} from 'modules/dxkultureBidAdapter.js'; +import {BANNER, VIDEO} from 'src/mediaTypes.js'; + +const getBannerRequest = () => { + return { + bidderCode: 'dxkulture', + auctionId: 'ba87bfdf-493e-4a88-8e26-17b4cbc9adbd', + bidderRequestId: 'bidderRequestId', + bids: [ + { + bidder: 'dxkulture', + params: { + placementId: 123456, + publisherId: 'publisherId', + bidfloor: 10, + }, + auctionId: 'auctionId-56a2-4f71-9098-720a68f2f708', + placementCode: 'div-gpt-dummy-placement-code', + mediaTypes: { + banner: { + sizes: [ + [ 300, 250 ], + ] + } + }, + bidId: '2e9f38ea93bb9e', + bidderRequestId: 'bidderRequestId', + } + ], + start: 1487883186070, + auctionStart: 1487883186069, + timeout: 3000 + } +}; + +const getVideoRequest = () => { + return { + bidderCode: 'dxkulture', + auctionId: 'e158486f-8c7f-472f-94ce-b0cbfbb50ab4', + bidderRequestId: '34feaad34lkj2', + bids: [{ + mediaTypes: { + video: { + context: 'instream', + playerSize: [[640, 480]], + } + }, + bidder: 'dxkulture', + sizes: [640, 480], + bidId: '30b3efwfwe1e', + adUnitCode: 'video1', + params: { + video: { + playerWidth: 640, + playerHeight: 480, + mimes: ['video/mp4', 'application/javascript'], + protocols: [2, 5], + api: [2], + position: 1, + delivery: [2], + sid: 134, + rewarded: 1, + placement: 1, + plcmt: 1, + hp: 1, + inventoryid: 123 + }, + site: { + id: 1, + page: 'https://test.com', + referrer: 'http://test.com' + }, + publisherId: 'km123', + bidfloor: 10, + } + }, { + mediaTypes: { + video: { + context: 'instream', + playerSize: [[640, 480]], + } + }, + bidder: 'dxkulture', + sizes: [640, 480], + bidId: '30b3efwfwe2e', + adUnitCode: 'video1', + params: { + video: { + playerWidth: 640, + playerHeight: 480, + mimes: ['video/mp4', 'application/javascript'], + protocols: [2, 5], + api: [2], + position: 1, + delivery: [2], + sid: 134, + rewarded: 1, + placement: 1, + plcmt: 1, + hp: 1, + inventoryid: 123 + }, + site: { + id: 1, + page: 'https://test.com', + referrer: 'http://test.com' + }, + publisherId: 'km123', + bidfloor: 10, + } + }], + auctionStart: 1520001292880, + timeout: 5000, + start: 1520001292884, + doneCbCallCount: 0, + refererInfo: { + numIframes: 1, + reachedTop: true, + referer: 'test.com' + } + }; +}; + +const getBidderResponse = () => { + return { + headers: null, + body: { + id: 'bid-response', + seatbid: [ + { + bid: [ + { + id: '2e9f38ea93bb9e', + impid: '2e9f38ea93bb9e', + price: 0.18, + adm: '', + adid: '144762342', + adomain: [ + 'https://dummydomain.com' + ], + iurl: 'iurl', + cid: '109', + crid: 'creativeId', + cat: [], + w: 300, + h: 250, + ext: { + prebid: { + type: 'banner' + }, + bidder: { + appnexus: { + brand_id: 334553, + auction_id: 514667951122925701, + bidder_id: 2, + bid_ad_type: 0 + } + } + } + } + ], + seat: 'dxkulture' + } + ], + ext: { + usersync: { + sovrn: { + status: 'none', + syncs: [ + { + url: 'urlsovrn', + type: 'iframe' + } + ] + }, + appnexus: { + status: 'none', + syncs: [ + { + url: 'urlappnexus', + type: 'pixel' + } + ] + } + }, + responsetimemillis: { + appnexus: 127 + } + } + } + }; +} + +describe('dxkultureBidAdapter', function() { + let videoBidRequest; + + const VIDEO_REQUEST = { + 'bidderCode': 'dxkulture', + 'auctionId': 'e158486f-8c7f-472f-94ce-b0cbfbb50ab4', + 'bidderRequestId': '34feaad34lkj2', + 'bids': videoBidRequest, + 'auctionStart': 1520001292880, + 'timeout': 3000, + 'start': 1520001292884, + 'doneCbCallCount': 0, + 'refererInfo': { + 'numIframes': 1, + 'reachedTop': true, + 'referer': 'test.com' + } + }; + + beforeEach(function () { + videoBidRequest = { + mediaTypes: { + video: { + context: 'instream', + playerSize: [[640, 480]], + } + }, + bidder: 'dxkulture', + sizes: [640, 480], + bidId: '30b3efwfwe1e', + adUnitCode: 'video1', + params: { + video: { + playerWidth: 640, + playerHeight: 480, + mimes: ['video/mp4', 'application/javascript'], + protocols: [2, 5], + api: [2], + position: 1, + delivery: [2], + sid: 134, + rewarded: 1, + placement: 1, + plcmt: 1, + hp: 1, + inventoryid: 123 + }, + site: { + id: 1, + page: 'https://test.com', + referrer: 'http://test.com' + }, + publisherId: 'km123', + bidfloor: 0 + } + }; + }); + + describe('isValidRequest', function() { + let bidderRequest; + + beforeEach(function() { + bidderRequest = getBannerRequest(); + }); + + it('should accept request if placementId and publisherId are passed', function () { + expect(spec.isBidRequestValid(bidderRequest.bids[0])).to.be.true; + }); + + it('reject requests without params', function () { + bidderRequest.bids[0].params = {}; + expect(spec.isBidRequestValid(bidderRequest.bids[0])).to.be.false; + }); + + it('returns false when banner mediaType does not exist', function () { + bidderRequest.bids[0].mediaTypes = {} + expect(spec.isBidRequestValid(bidderRequest.bids[0])).to.be.false; + }); + }); + + describe('buildRequests', function() { + let bidderRequest; + + beforeEach(function() { + bidderRequest = getBannerRequest(); + }); + + it('should return expected request object', function() { + const bidRequest = spec.buildRequests(bidderRequest.bids, bidderRequest); + expect(bidRequest.url).equal('https://ads.dxkulture.com/pbjs?pid=publisherId&placementId=123456'); + expect(bidRequest.method).equal('POST'); + }); + }); + + context('banner validation', function () { + let bidderRequest; + + beforeEach(function() { + bidderRequest = getBannerRequest(); + }); + + it('returns true when banner sizes are defined', function () { + const bid = { + bidder: 'dxkulture', + mediaTypes: { + banner: { + sizes: [[250, 300]] + } + }, + params: { + placementId: 'placementId', + publisherId: 'publisherId', + } + }; + + expect(spec.isBidRequestValid(bidderRequest.bids[0])).to.be.true; + }); + + it('returns false when banner sizes are invalid', function () { + const invalidSizes = [ + undefined, + '2:1', + 123, + 'test' + ]; + + invalidSizes.forEach((sizes) => { + const bid = { + bidder: 'dxkulture', + mediaTypes: { + banner: { + sizes + } + }, + params: { + placementId: 'placementId', + publisherId: 'publisherId', + } + }; + + expect(spec.isBidRequestValid(bid)).to.be.false; + }); + }); + }); + + context('video validation', function () { + beforeEach(function () { + // Basic Valid BidRequest + this.bid = { + bidder: 'dxkulture', + mediaTypes: { + video: { + playerSize: [[300, 50]], + context: 'instream', + mimes: ['foo', 'bar'], + protocols: [1, 2] + } + }, + params: { + placementId: 'placementId', + publisherId: 'publisherId', + } + }; + }); + + it('should return true (skip validations) when e2etest = true', function () { + this.bid.params = { + e2etest: true + }; + expect(spec.isBidRequestValid(this.bid)).to.equal(true); + }); + + it('returns false when video context is not defined', function () { + delete this.bid.mediaTypes.video.context; + + expect(spec.isBidRequestValid(this.bid)).to.be.false; + }); + + it('returns false when video playserSize is invalid', function () { + const invalidSizes = [ + undefined, + '2:1', + 123, + 'test' + ]; + + invalidSizes.forEach((playerSize) => { + this.bid.mediaTypes.video.playerSize = playerSize; + expect(spec.isBidRequestValid(this.bid)).to.be.false; + }); + }); + + it('returns false when video mimes is invalid', function () { + const invalidMimes = [ + undefined, + 'test', + 1, + [] + ] + + invalidMimes.forEach((mimes) => { + this.bid.mediaTypes.video.mimes = mimes; + expect(spec.isBidRequestValid(this.bid)).to.be.false; + }) + }); + + it('returns false when video protocols is invalid', function () { + const invalidMimes = [ + undefined, + 'test', + 1, + [] + ] + + invalidMimes.forEach((protocols) => { + this.bid.mediaTypes.video.protocols = protocols; + expect(spec.isBidRequestValid(this.bid)).to.be.false; + }) + }); + }); + + describe('buildRequests', function () { + let bidderBannerRequest; + let bidRequestsWithMediaTypes; + let mockBidderRequest; + + beforeEach(function() { + bidderBannerRequest = getBannerRequest(); + + mockBidderRequest = {refererInfo: {}}; + + bidRequestsWithMediaTypes = [{ + bidder: 'dxkulture', + params: { + publisherId: 'km123', + }, + adUnitCode: '/adunit-code/test-path', + mediaTypes: { + banner: { + sizes: [[300, 250], [300, 600]] + } + }, + bidId: 'test-bid-id-1', + bidderRequestId: 'test-bid-request-1', + auctionId: 'test-auction-1', + transactionId: 'test-transactionId-1', + ortb2Imp: { + ext: { + ae: 2 + } + } + }, { + bidder: 'dxkulture', + params: { + publisherId: 'km123', + }, + adUnitCode: 'adunit-code', + mediaTypes: { + video: { + playerSize: [640, 480], + placement: 1, + plcmt: 1, + } + }, + bidId: 'test-bid-id-2', + bidderRequestId: 'test-bid-request-2', + auctionId: 'test-auction-2', + transactionId: 'test-transactionId-2' + }]; + }); + + context('when mediaType is banner', function () { + it('creates request data', function () { + let request = spec.buildRequests(bidderBannerRequest.bids, bidderBannerRequest) + + expect(request).to.exist.and.to.be.a('object'); + const payload = request.data; + expect(payload.imp[0]).to.have.property('id', bidderBannerRequest.bids[0].bidId); + }); + + it('has gdpr data if applicable', function () { + const req = Object.assign({}, getBannerRequest(), { + gdprConsent: { + consentString: 'consentString', + gdprApplies: true, + } + }); + let request = spec.buildRequests(bidderBannerRequest.bids, req); + + const payload = request.data; + expect(payload.user.ext).to.have.property('consent', req.gdprConsent.consentString); + expect(payload.regs.ext).to.have.property('gdpr', 1); + }); + }); + + if (FEATURES.VIDEO) { + context('video', function () { + it('should create a POST request for every bid', function () { + const requests = spec.buildRequests(bidRequestsWithMediaTypes, mockBidderRequest); + expect(requests.method).to.equal('POST'); + expect(requests.url.trim()).to.equal(spec.ENDPOINT + '?pid=' + videoBidRequest.params.publisherId); + }); + + it('should attach request data', function () { + const requests = spec.buildRequests(bidRequestsWithMediaTypes, mockBidderRequest); + const data = requests.data; + const [width, height] = videoBidRequest.sizes; + const VERSION = '1.0.0'; + + expect(data.imp[1].video.w).to.equal(width); + expect(data.imp[1].video.h).to.equal(height); + expect(data.imp[1].bidfloor).to.equal(videoBidRequest.params.bidfloor); + expect(data.imp[1]['video']['placement']).to.equal(videoBidRequest.params.video['placement']); + expect(data.imp[1]['video']['plcmt']).to.equal(videoBidRequest.params.video['plcmt']); + expect(data.ext.prebidver).to.equal('$prebid.version$'); + expect(data.ext.adapterver).to.equal(spec.VERSION); + }); + + it('should set pubId to e2etest when bid.params.e2etest = true', function () { + bidRequestsWithMediaTypes[0].params.e2etest = true; + const requests = spec.buildRequests(bidRequestsWithMediaTypes, mockBidderRequest); + expect(requests.method).to.equal('POST'); + expect(requests.url).to.equal(spec.ENDPOINT + '?pid=e2etest'); + }); + + it('should attach End 2 End test data', function () { + bidRequestsWithMediaTypes[1].params.e2etest = true; + const requests = spec.buildRequests(bidRequestsWithMediaTypes, mockBidderRequest); + const data = requests.data; + expect(data.imp[1].bidfloor).to.equal(0); + expect(data.imp[1].video.w).to.equal(640); + expect(data.imp[1].video.h).to.equal(480); + }); + }); + } + }); + + describe('interpretResponse', function() { + context('when mediaType is banner', function() { + let bidRequest, bidderResponse; + beforeEach(function() { + const bidderRequest = getBannerRequest(); + bidRequest = spec.buildRequests(bidderRequest.bids, bidderRequest); + bidderResponse = getBidderResponse(); + }); + + it('handles empty response', function () { + const EMPTY_RESP = Object.assign({}, bidderResponse, {'body': {}}); + const bids = spec.interpretResponse(EMPTY_RESP, bidRequest); + + expect(bids).to.be.empty; + }); + + it('have bids', function () { + let bids = spec.interpretResponse(bidderResponse, bidRequest); + expect(bids).to.be.an('array').that.is.not.empty; + validateBidOnIndex(0); + + function validateBidOnIndex(index) { + expect(bids[index]).to.have.property('currency', 'USD'); + expect(bids[index]).to.have.property('requestId', getBidderResponse().body.seatbid[0].bid[index].impid); + expect(bids[index]).to.have.property('cpm', getBidderResponse().body.seatbid[0].bid[index].price); + expect(bids[index]).to.have.property('width', getBidderResponse().body.seatbid[0].bid[index].w); + expect(bids[index]).to.have.property('height', getBidderResponse().body.seatbid[0].bid[index].h); + expect(bids[index]).to.have.property('ad', getBidderResponse().body.seatbid[0].bid[index].adm); + expect(bids[index]).to.have.property('creativeId', getBidderResponse().body.seatbid[0].bid[index].crid); + expect(bids[index].meta).to.have.property('advertiserDomains'); + expect(bids[index]).to.have.property('ttl', 300); + expect(bids[index]).to.have.property('netRevenue', true); + } + }); + }); + + context('when mediaType is video', function () { + let bidRequest, bidderResponse; + beforeEach(function() { + const bidderRequest = getVideoRequest(); + bidRequest = spec.buildRequests(bidderRequest.bids, bidderRequest); + bidderResponse = getBidderResponse(); + }); + + it('handles empty response', function () { + const EMPTY_RESP = Object.assign({}, bidderResponse, {'body': {}}); + const bids = spec.interpretResponse(EMPTY_RESP, bidRequest); + + expect(bids).to.be.empty; + }); + + it('should return no bids if the response "nurl" and "adm" are missing', function () { + const SERVER_RESP = Object.assign({}, bidderResponse, {'body': { + seatbid: [{ + bid: [{ + price: 6.01 + }] + }] + }}); + const bids = spec.interpretResponse(SERVER_RESP, bidRequest); + expect(bids.length).to.equal(0); + }); + + it('should return no bids if the response "price" is missing', function () { + const SERVER_RESP = Object.assign({}, bidderResponse, {'body': { + seatbid: [{ + bid: [{ + adm: '![\"Ranger's](\"https://d2cli4kgl5uxre.cloudfront.net/ML/ff32b6f9b3bbc45c00b78b6674a2952e__scv1__300x175.png\")
test
',
+ crid: '1234',
+ }
+ ]
+ }
+ ],
+ ext: {}
+ }
+ }
+
+ describe('isBidRequestValid', () => {
+ const bid = bidRequests[0];
+
+ it('should return true when required params found', function () {
+ expect(spec.isBidRequestValid(bid)).to.equal(true);
+ });
+
+ it('should return false when required params are not present', function () {
+ const invalidBid = { ...bid, params: {} };
+ expect(spec.isBidRequestValid(invalidBid)).to.equal(false);
+ });
+
+ it('should return false when required param "pid" is not present', function () {
+ const invalidBid = { ...bid, params: { ...bid.params, pid: undefined } };
+ expect(spec.isBidRequestValid(invalidBid)).to.equal(false);
+ });
+
+ it('should return false when required param "rid" is not present', function () {
+ const invalidBid = { ...bid, params: { ...bid.params, rid: undefined } };
+ expect(spec.isBidRequestValid(invalidBid)).to.equal(false);
+ });
+ });
+
+ describe('buildRequests', () => {
+ it('should build the request', function () {
+ const request = spec.buildRequests(bidRequests, {});
+ const payload = request.data;
+ const url = request.url;
+
+ expect(url).to.equal(ENDPOINT_URL);
+
+ expect(payload.site).to.exist;
+ expect(payload.site.publisher).to.exist;
+ expect(payload.site.publisher.id).to.exist;
+ expect(payload.site.publisher.id).to.equal(rid);
+ expect(payload.site.domain).to.exist;
+ expect(payload.site.domain).to.equal(rid);
+
+ expect(payload.imp).to.exist;
+ expect(payload.imp[0]).to.exist;
+ expect(payload.imp[0].ext).to.exist;
+ expect(payload.imp[0].ext.prebid).to.exist;
+ expect(payload.imp[0].ext.prebid.storedrequest).to.exist;
+ expect(payload.imp[0].ext.prebid.storedrequest.id).to.exist;
+ expect(payload.imp[0].ext.prebid.storedrequest.id).to.equal(pid.toString());
+ });
+ });
+
+ describe('interpretResponse', () => {
+ it('should interpret the response by pushing it in the bids elem', function () {
+ const allResponses = spec.interpretResponse(serverResponse);
+ const response = allResponses[0];
+ const seatbid = serverResponse.body.seatbid[0].bid[0];
+
+ expect(response.requestId).to.exist;
+ expect(response.requestId).to.equal(seatbid.impid);
+ expect(response.cpm).to.exist;
+ expect(response.cpm).to.equal(seatbid.price);
+ expect(response.width).to.exist;
+ expect(response.width).to.equal(seatbid.w);
+ expect(response.height).to.exist;
+ expect(response.height).to.equal(seatbid.h);
+ expect(response.ad).to.exist;
+ expect(response.ad).to.equal(seatbid.adm);
+ expect(response.ttl).to.exist;
+ expect(response.creativeId).to.exist;
+ expect(response.creativeId).to.equal(seatbid.crid);
+ expect(response.netRevenue).to.exist;
+ expect(response.currency).to.exist;
+ });
+ });
+
+ describe('getUserSyncs', function() {
+ it('should retrieve user iframe syncs', function () {
+ expect(spec.getUserSyncs({ iframeEnabled: true }, [serverResponse], undefined, undefined)).to.deep.equal([{
+ type: 'iframe',
+ url: 'https://cdn-a.yieldlove.com/load-cookie.html?endpoint=yieldlove&max_sync_count=100&gdpr=NaN&gdpr_consent=&'
+ }]);
+
+ expect(spec.getUserSyncs({ iframeEnabled: true }, [serverResponse], { gdprApplies: true, consentString: 'example' }, undefined)).to.deep.equal([{
+ type: 'iframe',
+ url: 'https://cdn-a.yieldlove.com/load-cookie.html?endpoint=yieldlove&max_sync_count=100&gdpr=1&gdpr_consent=example&'
+ }]);
+ });
+ });
+})
diff --git a/test/spec/modules/yieldmoBidAdapter_spec.js b/test/spec/modules/yieldmoBidAdapter_spec.js
index 25fe176553d..edb3ef3af27 100644
--- a/test/spec/modules/yieldmoBidAdapter_spec.js
+++ b/test/spec/modules/yieldmoBidAdapter_spec.js
@@ -47,7 +47,7 @@ describe('YieldmoAdapter', function () {
video: {
playerSize: [640, 480],
context: 'instream',
- mimes: ['video/mp4']
+ mimes: ['video/mp4'],
},
},
params: {
@@ -61,11 +61,11 @@ describe('YieldmoAdapter', function () {
api: [2, 3],
skipppable: true,
playbackmethod: [1, 2],
- ...videoParams
- }
+ ...videoParams,
+ },
},
transactionId: '54a58774-7a41-494e-8cbc-fa7b79164f0c',
- ...rootParams
+ ...rootParams,
});
const mockBidderRequest = (params = {}, bids = [mockBannerBid()]) => ({
@@ -74,7 +74,6 @@ describe('YieldmoAdapter', function () {
bidderRequestId: '14c4ede8c693f',
bids,
auctionStart: 1520001292880,
- timeout: 3000,
start: 1520001292884,
doneCbCallCount: 0,
refererInfo: {
@@ -169,6 +168,14 @@ describe('YieldmoAdapter', function () {
expect(requests[0].url).to.be.equal(BANNER_ENDPOINT);
});
+ it('should pass default timeout in bid request', function () {
+ const requests = build([mockBannerBid()]);
+ expect(requests[0].data.tmax).to.equal(400);
+ });
+ it('should pass tmax to bid request', function () {
+ const requests = build([mockBannerBid()], mockBidderRequest({timeout: 1000}));
+ expect(requests[0].data.tmax).to.equal(1000);
+ });
it('should not blow up if crumbs is undefined', function () {
expect(function () {
build([mockBannerBid({crumbs: undefined})]);
@@ -425,6 +432,18 @@ describe('YieldmoAdapter', function () {
expect(requests[0].url).to.be.equal(VIDEO_ENDPOINT);
});
+ it('should not require params.video if required props in mediaTypes.video', function () {
+ videoBid.mediaTypes.video = {
+ ...videoBid.mediaTypes.video,
+ ...videoBid.params.video
+ };
+ delete videoBid.params.video;
+ const requests = build([videoBid]);
+ expect(requests.length).to.equal(1);
+ expect(requests[0].method).to.equal('POST');
+ expect(requests[0].url).to.be.equal(VIDEO_ENDPOINT);
+ });
+
it('should add mediaTypes.video prop to the imp.video prop', function () {
utils.deepAccess(videoBid, 'mediaTypes.video')['minduration'] = 40;
expect(buildVideoBidAndGetVideoParam().minduration).to.equal(40);
@@ -441,6 +460,16 @@ describe('YieldmoAdapter', function () {
expect(buildVideoBidAndGetVideoParam().minduration).to.deep.equal(['video/mp4']);
});
+ it('should add plcmt value to the imp.video', function () {
+ const videoBid = mockVideoBid({}, {}, { plcmt: 1 });
+ expect(utils.deepAccess(videoBid, 'params.video')['plcmt']).to.equal(1);
+ });
+
+ it('should add start delay if plcmt value is not 1', function () {
+ const videoBid = mockVideoBid({}, {}, { plcmt: 2 });
+ expect(build([videoBid])[0].data.imp[0].video.startdelay).to.equal(0);
+ });
+
it('should override mediaTypes.video.mimes prop if params.video.mimes is present', function () {
utils.deepAccess(videoBid, 'mediaTypes.video')['mimes'] = ['video/mp4'];
utils.deepAccess(videoBid, 'params.video')['mimes'] = ['video/mkv'];
diff --git a/test/spec/modules/zeta_global_sspAnalyticsAdapter_spec.js b/test/spec/modules/zeta_global_sspAnalyticsAdapter_spec.js
index cbba815cfc1..5194a6a526a 100644
--- a/test/spec/modules/zeta_global_sspAnalyticsAdapter_spec.js
+++ b/test/spec/modules/zeta_global_sspAnalyticsAdapter_spec.js
@@ -2,19 +2,20 @@ import zetaAnalyticsAdapter from 'modules/zeta_global_sspAnalyticsAdapter.js';
import {config} from 'src/config';
import CONSTANTS from 'src/constants.json';
import {server} from '../../mocks/xhr.js';
+import {logError} from '../../../src/utils';
let utils = require('src/utils');
let events = require('src/events');
-const MOCK = {
- STUB: {
- 'auctionId': '25c6d7f5-699a-4bfc-87c9-996f915341fa'
- },
+const EVENTS = {
AUCTION_END: {
'auctionId': '75e394d9-ccce-4978-9238-91e6a1ac88a1',
'timestamp': 1638441234544,
'auctionEnd': 1638441234784,
'auctionStatus': 'completed',
+ 'metrics': {
+ 'someMetric': 1
+ },
'adUnits': [
{
'code': '/19968336/header-bid-tag-0',
@@ -74,13 +75,6 @@ const MOCK = {
'bids': [
{
'bidder': 'zeta_global_ssp',
- 'params': {
- 'sid': 111,
- 'tags': {
- 'shortname': 'prebid_analytics_event_test_shortname',
- 'position': 'test_position'
- }
- },
'mediaTypes': {
'banner': {
'sizes': [
@@ -309,6 +303,9 @@ const MOCK = {
'cpm': 2.258302852806723,
'currency': 'USD',
'ad': 'test_ad',
+ 'metrics': {
+ 'someMetric': 0
+ },
'ttl': 200,
'creativeId': '456456456',
'netRevenue': true,
@@ -344,11 +341,7 @@ const MOCK = {
'status': 'rendered',
'params': [
{
- 'sid': 111,
- 'tags': {
- 'shortname': 'prebid_analytics_event_test_shortname',
- 'position': 'test_position'
- }
+ 'nonZetaParam': 'nonZetaValue'
}
]
},
@@ -392,33 +385,45 @@ describe('Zeta Global SSP Analytics Adapter', function() {
zetaAnalyticsAdapter.disableAnalytics();
});
- it('events are sent', function() {
- this.timeout(5000);
- events.emit(CONSTANTS.EVENTS.AUCTION_INIT, MOCK.STUB);
- events.emit(CONSTANTS.EVENTS.AUCTION_END, MOCK.AUCTION_END);
- events.emit(CONSTANTS.EVENTS.BID_ADJUSTMENT, MOCK.STUB);
- events.emit(CONSTANTS.EVENTS.BID_TIMEOUT, MOCK.STUB);
- events.emit(CONSTANTS.EVENTS.BID_REQUESTED, MOCK.STUB);
- events.emit(CONSTANTS.EVENTS.BID_RESPONSE, MOCK.STUB);
- events.emit(CONSTANTS.EVENTS.NO_BID, MOCK.STUB);
- events.emit(CONSTANTS.EVENTS.BID_WON, MOCK.STUB);
- events.emit(CONSTANTS.EVENTS.BIDDER_DONE, MOCK.STUB);
- events.emit(CONSTANTS.EVENTS.BIDDER_ERROR, MOCK.STUB);
- events.emit(CONSTANTS.EVENTS.SET_TARGETING, MOCK.STUB);
- events.emit(CONSTANTS.EVENTS.BEFORE_REQUEST_BIDS, MOCK.STUB);
- events.emit(CONSTANTS.EVENTS.BEFORE_BIDDER_HTTP, MOCK.STUB);
- events.emit(CONSTANTS.EVENTS.REQUEST_BIDS, MOCK.STUB);
- events.emit(CONSTANTS.EVENTS.ADD_AD_UNITS, MOCK.STUB);
- events.emit(CONSTANTS.EVENTS.AD_RENDER_FAILED, MOCK.STUB);
- events.emit(CONSTANTS.EVENTS.AD_RENDER_SUCCEEDED, MOCK.AD_RENDER_SUCCEEDED);
- events.emit(CONSTANTS.EVENTS.TCF2_ENFORCEMENT, MOCK.STUB);
- events.emit(CONSTANTS.EVENTS.AUCTION_DEBUG, MOCK.STUB);
- events.emit(CONSTANTS.EVENTS.BID_VIEWABLE, MOCK.STUB);
- events.emit(CONSTANTS.EVENTS.STALE_RENDER, MOCK.STUB);
+ it('Move ZetaParams through analytics events', function() {
+ this.timeout(3000);
+
+ events.emit(CONSTANTS.EVENTS.AUCTION_END, EVENTS.AUCTION_END);
+ events.emit(CONSTANTS.EVENTS.AD_RENDER_SUCCEEDED, EVENTS.AD_RENDER_SUCCEEDED);
+
+ expect(requests.length).to.equal(2);
+ const auctionEnd = JSON.parse(requests[0].requestBody);
+ const auctionSucceeded = JSON.parse(requests[1].requestBody);
+
+ expect(auctionSucceeded.bid.params[0]).to.be.deep.equal(EVENTS.AUCTION_END.adUnits[0].bids[0].params);
+ expect(EVENTS.AUCTION_END.adUnits[0].bids[0].bidder).to.be.equal('zeta_global_ssp');
+ });
+
+ it('Keep only needed fields', function() {
+ this.timeout(3000);
+
+ events.emit(CONSTANTS.EVENTS.AUCTION_END, EVENTS.AUCTION_END);
+ events.emit(CONSTANTS.EVENTS.AD_RENDER_SUCCEEDED, EVENTS.AD_RENDER_SUCCEEDED);
expect(requests.length).to.equal(2);
- expect(JSON.parse(requests[0].requestBody)).to.deep.equal(MOCK.AUCTION_END);
- expect(JSON.parse(requests[1].requestBody)).to.deep.equal(MOCK.AD_RENDER_SUCCEEDED);
+ const auctionEnd = JSON.parse(requests[0].requestBody);
+ const auctionSucceeded = JSON.parse(requests[1].requestBody);
+
+ expect(auctionEnd.adUnitCodes[0]).to.be.equal('/19968336/header-bid-tag-0');
+ expect(auctionEnd.adUnits[0].bids[0].bidder).to.be.equal('zeta_global_ssp');
+ expect(auctionEnd.auctionEnd).to.be.equal(1638441234784);
+ expect(auctionEnd.auctionId).to.be.equal('75e394d9-ccce-4978-9238-91e6a1ac88a1');
+ expect(auctionEnd.bidderRequests[0].bidderCode).to.be.equal('zeta_global_ssp');
+ expect(auctionEnd.bidsReceived[0].bidderCode).to.be.equal('zeta_global_ssp');
+ expect(auctionEnd.noBids[0].bidder).to.be.equal('appnexus');
+
+ expect(auctionSucceeded.adId).to.be.equal('5759bb3ef7be1e8');
+ expect(auctionSucceeded.bid.auctionId).to.be.equal('75e394d9-ccce-4978-9238-91e6a1ac88a1');
+ expect(auctionSucceeded.bid.requestId).to.be.equal('206be9a13236af');
+ expect(auctionSucceeded.bid.bidderCode).to.be.equal('zeta_global_ssp');
+ expect(auctionSucceeded.bid.creativeId).to.be.equal('456456456');
+ expect(auctionSucceeded.bid.size).to.be.equal('480x320');
+ expect(auctionSucceeded.doc.location.hostname).to.be.equal('localhost');
});
});
});
diff --git a/test/spec/modules/zeta_global_sspBidAdapter_spec.js b/test/spec/modules/zeta_global_sspBidAdapter_spec.js
index 601f4546a29..9ef97019a98 100644
--- a/test/spec/modules/zeta_global_sspBidAdapter_spec.js
+++ b/test/spec/modules/zeta_global_sspBidAdapter_spec.js
@@ -1,5 +1,6 @@
import {spec} from '../../../modules/zeta_global_sspBidAdapter.js'
import {BANNER, VIDEO} from '../../../src/mediaTypes';
+import {deepClone} from '../../../src/utils';
describe('Zeta Ssp Bid Adapter', function () {
const eids = [
@@ -50,7 +51,6 @@ describe('Zeta Ssp Bid Adapter', function () {
someTag: 444,
},
sid: 'publisherId',
- shortname: 'test_shortname',
tagid: 'test_tag_id',
site: {
page: 'testPage'
@@ -124,7 +124,24 @@ describe('Zeta Ssp Bid Adapter', function () {
uspConsent: 'someCCPAString',
params: params,
userIdAsEids: eids,
- timeout: 500
+ timeout: 500,
+ ortb2: {
+ user: {
+ data: [
+ {
+ ext: {
+ segtax: 600,
+ segclass: 'classifier_v1'
+ },
+ segment: [
+ { id: '3' },
+ { id: '44' },
+ { id: '59' }
+ ]
+ }
+ ]
+ }
+ }
}];
const bannerWithFewSizesRequest = [{
@@ -253,11 +270,13 @@ describe('Zeta Ssp Bid Adapter', function () {
};
it('Test the bid validation function', function () {
- const validBid = spec.isBidRequestValid(bannerRequest[0]);
- const invalidBid = spec.isBidRequestValid(null);
+ const invalidBid = deepClone(bannerRequest[0]);
+ invalidBid.params = {};
+ const isValidBid = spec.isBidRequestValid(bannerRequest[0]);
+ const isInvalidBid = spec.isBidRequestValid(null);
- expect(validBid).to.be.true;
- expect(invalidBid).to.be.false;
+ expect(isValidBid).to.be.true;
+ expect(isInvalidBid).to.be.false;
});
it('Test provide eids', function () {
@@ -453,7 +472,7 @@ describe('Zeta Ssp Bid Adapter', function () {
it('Test required params in banner request', function () {
const request = spec.buildRequests(bannerRequest, bannerRequest[0]);
const payload = JSON.parse(request.data);
- expect(request.url).to.eql('https://ssp.disqus.com/bid/prebid?shortname=test_shortname');
+ expect(request.url).to.eql('https://ssp.disqus.com/bid/prebid?sid=publisherId');
expect(payload.ext.sid).to.eql('publisherId');
expect(payload.ext.tags.someTag).to.eql(444);
expect(payload.ext.tags.shortname).to.be.undefined;
@@ -462,7 +481,7 @@ describe('Zeta Ssp Bid Adapter', function () {
it('Test required params in video request', function () {
const request = spec.buildRequests(videoRequest, videoRequest[0]);
const payload = JSON.parse(request.data);
- expect(request.url).to.eql('https://ssp.disqus.com/bid/prebid?shortname=test_shortname');
+ expect(request.url).to.eql('https://ssp.disqus.com/bid/prebid?sid=publisherId');
expect(payload.ext.sid).to.eql('publisherId');
expect(payload.ext.tags.someTag).to.eql(444);
expect(payload.ext.tags.shortname).to.be.undefined;
@@ -471,7 +490,7 @@ describe('Zeta Ssp Bid Adapter', function () {
it('Test multi imp', function () {
const request = spec.buildRequests(multiImpRequest, multiImpRequest[0]);
const payload = JSON.parse(request.data);
- expect(request.url).to.eql('https://ssp.disqus.com/bid/prebid?shortname=test_shortname');
+ expect(request.url).to.eql('https://ssp.disqus.com/bid/prebid?sid=publisherId');
expect(payload.imp.length).to.eql(2);
@@ -604,4 +623,13 @@ describe('Zeta Ssp Bid Adapter', function () {
expect(bidResponse[0].ad).to.eql(zetaResponse.body.seatbid[0].bid[0].adm);
expect(bidResponse[0].vastXml).to.be.undefined;
});
+
+ it('Test provide segments into the request', function () {
+ const request = spec.buildRequests(bannerRequest, bannerRequest[0]);
+ const payload = JSON.parse(request.data);
+ expect(payload.user.data[0].segment.length).to.eql(3);
+ expect(payload.user.data[0].segment[0].id).to.eql('3');
+ expect(payload.user.data[0].segment[1].id).to.eql('44');
+ expect(payload.user.data[0].segment[2].id).to.eql('59');
+ });
});
diff --git a/test/spec/unit/core/adapterManager_spec.js b/test/spec/unit/core/adapterManager_spec.js
index cff26df2e4d..98d841d9c7c 100644
--- a/test/spec/unit/core/adapterManager_spec.js
+++ b/test/spec/unit/core/adapterManager_spec.js
@@ -965,13 +965,23 @@ describe('adapterManager tests', function () {
}];
it('invokes callBids on the S2S adapter', function () {
+ const done = sinon.stub();
+ const onTimelyResponse = sinon.stub();
+ prebidServerAdapterMock.callBids.callsFake((_1, _2, _3, done) => {
+ done();
+ });
adapterManager.callBids(
getAdUnits(),
bidRequests,
() => {},
- () => () => {}
+ done,
+ undefined,
+ undefined,
+ onTimelyResponse
);
sinon.assert.calledTwice(prebidServerAdapterMock.callBids);
+ sinon.assert.calledTwice(done);
+ bidRequests.forEach(br => sinon.assert.calledWith(onTimelyResponse, br.bidderRequestId));
});
// Enable this test when prebidServer adapter is made 1.0 compliant
diff --git a/test/spec/unit/core/ajax_spec.js b/test/spec/unit/core/ajax_spec.js
index df0ce02c15c..a3a0459b980 100644
--- a/test/spec/unit/core/ajax_spec.js
+++ b/test/spec/unit/core/ajax_spec.js
@@ -1,7 +1,8 @@
-import {dep, attachCallbacks, fetcherFactory, toFetchRequest} from '../../../../src/ajax.js';
+import {attachCallbacks, dep, fetcherFactory, toFetchRequest} from '../../../../src/ajax.js';
import {config} from 'src/config.js';
import {server} from '../../../mocks/xhr.js';
-import {sandbox} from 'sinon';
+import * as utils from 'src/utils.js';
+import {logError} from 'src/utils.js';
const EXAMPLE_URL = 'https://www.example.com';
@@ -312,13 +313,24 @@ describe('attachCallbacks', () => {
const cbType = success ? 'success' : 'error';
describe(`for ${t}`, () => {
- let response, body;
+ let sandbox, response, body;
beforeEach(() => {
+ sandbox = sinon.sandbox.create();
+ sandbox.spy(utils, 'logError');
({response, body} = makeResponse());
});
+ afterEach(() => {
+ sandbox.restore();
+ })
+
function checkXHR(xhr) {
- sinon.assert.match(xhr, {
+ utils.logError.resetHistory();
+ const serialized = JSON.parse(JSON.stringify(xhr))
+ // serialization of `responseXML` should not generate console messages
+ sinon.assert.notCalled(utils.logError);
+
+ sinon.assert.match(serialized, {
readyState: XMLHttpRequest.DONE,
status: response.status,
statusText: response.statusText,
@@ -330,7 +342,7 @@ describe('attachCallbacks', () => {
if (xml) {
expect(xhr.responseXML.querySelectorAll('*').length > 0).to.be.true;
} else {
- expect(xhr.responseXML).to.not.exist;
+ expect(serialized.responseXML).to.not.exist;
}
Array.from(response.headers.entries()).forEach(([name, value]) => {
expect(xhr.getResponseHeader(name)).to.eql(value);
diff --git a/test/spec/unit/core/bidderFactory_spec.js b/test/spec/unit/core/bidderFactory_spec.js
index 0360679ca52..9dcdb627698 100644
--- a/test/spec/unit/core/bidderFactory_spec.js
+++ b/test/spec/unit/core/bidderFactory_spec.js
@@ -48,1040 +48,1151 @@ before(() => {
let wrappedCallback = config.callbackWithBidder(CODE);
-describe('bidders created by newBidder', function () {
- let spec;
- let bidder;
- let addBidResponseStub;
- let doneStub;
-
- beforeEach(function () {
- spec = {
- code: CODE,
- isBidRequestValid: sinon.stub(),
- buildRequests: sinon.stub(),
- interpretResponse: sinon.stub(),
- getUserSyncs: sinon.stub()
- };
-
- addBidResponseStub = sinon.stub();
- addBidResponseStub.reject = sinon.stub();
- doneStub = sinon.stub();
- });
-
- describe('when the ajax response is irrelevant', function () {
- let sandbox;
- let ajaxStub;
- let getConfigSpy;
- let aliasRegistryStub, aliasRegistry;
+describe('bidderFactory', () => {
+ describe('bidders created by newBidder', function () {
+ let spec;
+ let bidder;
+ let addBidResponseStub;
+ let doneStub;
beforeEach(function () {
- sandbox = sinon.sandbox.create();
- sandbox.stub(activityRules, 'isActivityAllowed').callsFake(() => true);
- ajaxStub = sandbox.stub(ajax, 'ajax');
- addBidResponseStub.reset();
- getConfigSpy = sandbox.spy(config, 'getConfig');
- doneStub.reset();
- aliasRegistry = {};
- aliasRegistryStub = sandbox.stub(adapterManager, 'aliasRegistry');
- aliasRegistryStub.get(() => aliasRegistry);
- });
+ spec = {
+ code: CODE,
+ isBidRequestValid: sinon.stub(),
+ buildRequests: sinon.stub(),
+ interpretResponse: sinon.stub(),
+ getUserSyncs: sinon.stub()
+ };
- afterEach(function () {
- sandbox.restore();
+ addBidResponseStub = sinon.stub();
+ addBidResponseStub.reject = sinon.stub();
+ doneStub = sinon.stub();
});
- it('should let registerSyncs run with invalid alias and aliasSync enabled', function () {
- config.setConfig({
- userSync: {
- aliasSyncEnabled: true
- }
+ describe('when the ajax response is irrelevant', function () {
+ let sandbox;
+ let ajaxStub;
+ let getConfigSpy;
+ let aliasRegistryStub, aliasRegistry;
+
+ beforeEach(function () {
+ sandbox = sinon.sandbox.create();
+ sandbox.stub(activityRules, 'isActivityAllowed').callsFake(() => true);
+ ajaxStub = sandbox.stub(ajax, 'ajax');
+ addBidResponseStub.reset();
+ getConfigSpy = sandbox.spy(config, 'getConfig');
+ doneStub.reset();
+ aliasRegistry = {};
+ aliasRegistryStub = sandbox.stub(adapterManager, 'aliasRegistry');
+ aliasRegistryStub.get(() => aliasRegistry);
});
- spec.code = 'fakeBidder';
- const bidder = newBidder(spec);
- bidder.callBids({ bids: [] }, addBidResponseStub, doneStub, ajaxStub, onTimelyResponseStub, wrappedCallback);
- expect(getConfigSpy.withArgs('userSync.filterSettings').calledOnce).to.equal(true);
- });
- it('should let registerSyncs run with valid alias and aliasSync enabled', function () {
- config.setConfig({
- userSync: {
- aliasSyncEnabled: true
- }
+ afterEach(function () {
+ sandbox.restore();
});
- spec.code = 'aliasBidder';
- const bidder = newBidder(spec);
- bidder.callBids({ bids: [] }, addBidResponseStub, doneStub, ajaxStub, onTimelyResponseStub, wrappedCallback);
- expect(getConfigSpy.withArgs('userSync.filterSettings').calledOnce).to.equal(true);
- });
- it('should let registerSyncs run with invalid alias and aliasSync disabled', function () {
- config.setConfig({
- userSync: {
- aliasSyncEnabled: false
- }
+ it('should let registerSyncs run with invalid alias and aliasSync enabled', function () {
+ config.setConfig({
+ userSync: {
+ aliasSyncEnabled: true
+ }
+ });
+ spec.code = 'fakeBidder';
+ const bidder = newBidder(spec);
+ bidder.callBids({ bids: [] }, addBidResponseStub, doneStub, ajaxStub, onTimelyResponseStub, wrappedCallback);
+ expect(getConfigSpy.withArgs('userSync.filterSettings').calledOnce).to.equal(true);
});
- spec.code = 'fakeBidder';
- const bidder = newBidder(spec);
- bidder.callBids({ bids: [] }, addBidResponseStub, doneStub, ajaxStub, onTimelyResponseStub, wrappedCallback);
- expect(getConfigSpy.withArgs('userSync.filterSettings').calledOnce).to.equal(true);
- });
- it('should not let registerSyncs run with valid alias and aliasSync disabled', function () {
- config.setConfig({
- userSync: {
- aliasSyncEnabled: false
- }
+ it('should let registerSyncs run with valid alias and aliasSync enabled', function () {
+ config.setConfig({
+ userSync: {
+ aliasSyncEnabled: true
+ }
+ });
+ spec.code = 'aliasBidder';
+ const bidder = newBidder(spec);
+ bidder.callBids({ bids: [] }, addBidResponseStub, doneStub, ajaxStub, onTimelyResponseStub, wrappedCallback);
+ expect(getConfigSpy.withArgs('userSync.filterSettings').calledOnce).to.equal(true);
});
- spec.code = 'aliasBidder';
- const bidder = newBidder(spec);
- aliasRegistry = {[spec.code]: CODE};
- bidder.callBids({ bids: [] }, addBidResponseStub, doneStub, ajaxStub, onTimelyResponseStub, wrappedCallback);
- expect(getConfigSpy.withArgs('userSync.filterSettings').calledOnce).to.equal(false);
- });
- describe('transaction IDs', () => {
- beforeEach(() => {
- activityRules.isActivityAllowed.reset();
- ajaxStub.callsFake((_, callback) => callback.success(null, {getResponseHeader: sinon.stub()}));
- spec.interpretResponse.callsFake(() => [
- {
- requestId: 'bid',
- cpm: 123,
- ttl: 300,
- creativeId: 'crid',
- netRevenue: true,
- currency: 'USD'
+ it('should let registerSyncs run with invalid alias and aliasSync disabled', function () {
+ config.setConfig({
+ userSync: {
+ aliasSyncEnabled: false
+ }
+ });
+ spec.code = 'fakeBidder';
+ const bidder = newBidder(spec);
+ bidder.callBids({ bids: [] }, addBidResponseStub, doneStub, ajaxStub, onTimelyResponseStub, wrappedCallback);
+ expect(getConfigSpy.withArgs('userSync.filterSettings').calledOnce).to.equal(true);
+ });
+
+ it('should not let registerSyncs run with valid alias and aliasSync disabled', function () {
+ config.setConfig({
+ userSync: {
+ aliasSyncEnabled: false
}
- ])
+ });
+ spec.code = 'aliasBidder';
+ const bidder = newBidder(spec);
+ aliasRegistry = {[spec.code]: CODE};
+ bidder.callBids({ bids: [] }, addBidResponseStub, doneStub, ajaxStub, onTimelyResponseStub, wrappedCallback);
+ expect(getConfigSpy.withArgs('userSync.filterSettings').calledOnce).to.equal(false);
});
- Object.entries({
- 'be hidden': false,
- 'not be hidden': true,
- }).forEach(([t, allowed]) => {
- const expectation = allowed ? (val) => expect(val).to.exist : (val) => expect(val).to.not.exist;
+ describe('transaction IDs', () => {
+ beforeEach(() => {
+ activityRules.isActivityAllowed.reset();
+ ajaxStub.callsFake((_, callback) => callback.success(null, {getResponseHeader: sinon.stub()}));
+ spec.interpretResponse.callsFake(() => [
+ {
+ requestId: 'bid',
+ cpm: 123,
+ ttl: 300,
+ creativeId: 'crid',
+ netRevenue: true,
+ currency: 'USD'
+ }
+ ])
+ });
- function checkBidRequest(br) {
- ['auctionId', 'transactionId'].forEach((prop) => expectation(br[prop]));
- }
+ Object.entries({
+ 'be hidden': false,
+ 'not be hidden': true,
+ }).forEach(([t, allowed]) => {
+ const expectation = allowed ? (val) => expect(val).to.exist : (val) => expect(val).to.not.exist;
- function checkBidderRequest(br) {
- expectation(br.auctionId);
- br.bids.forEach(checkBidRequest);
- }
+ function checkBidRequest(br) {
+ ['auctionId', 'transactionId'].forEach((prop) => expectation(br[prop]));
+ }
- it(`should ${t} from the spec logic when the transmitTid activity is${allowed ? '' : ' not'} allowed`, () => {
- spec.isBidRequestValid.callsFake(br => {
- checkBidRequest(br);
- return true;
- });
- spec.buildRequests.callsFake((bidReqs, bidderReq) => {
- checkBidderRequest(bidderReq);
- bidReqs.forEach(checkBidRequest);
- return {method: 'POST'};
- });
- activityRules.isActivityAllowed.callsFake(() => allowed);
+ function checkBidderRequest(br) {
+ expectation(br.auctionId);
+ br.bids.forEach(checkBidRequest);
+ }
- const bidder = newBidder(spec);
+ it(`should ${t} from the spec logic when the transmitTid activity is${allowed ? '' : ' not'} allowed`, () => {
+ spec.isBidRequestValid.callsFake(br => {
+ checkBidRequest(br);
+ return true;
+ });
+ spec.buildRequests.callsFake((bidReqs, bidderReq) => {
+ checkBidderRequest(bidderReq);
+ bidReqs.forEach(checkBidRequest);
+ return {method: 'POST'};
+ });
+ activityRules.isActivityAllowed.callsFake(() => allowed);
+
+ const bidder = newBidder(spec);
+
+ bidder.callBids({
+ bidderCode: 'mockBidder',
+ auctionId: 'aid',
+ bids: [
+ {
+ adUnitCode: 'mockAU',
+ bidId: 'bid',
+ transactionId: 'tid',
+ auctionId: 'aid'
+ }
+ ]
+ }, addBidResponseStub, doneStub, ajaxStub, onTimelyResponseStub, wrappedCallback);
+
+ sinon.assert.calledWithMatch(activityRules.isActivityAllowed, ACTIVITY_TRANSMIT_TID, {
+ componentType: MODULE_TYPE_BIDDER,
+ componentName: 'mockBidder'
+ });
+ sinon.assert.calledWithMatch(addBidResponseStub, sinon.match.any, {
+ transactionId: 'tid',
+ auctionId: 'aid'
+ })
+ });
+ });
- bidder.callBids({
+ it('should not be hidden from request methods', (done) => {
+ const bidderRequest = {
bidderCode: 'mockBidder',
auctionId: 'aid',
+ getAID() { return this.auctionId },
bids: [
{
adUnitCode: 'mockAU',
bidId: 'bid',
transactionId: 'tid',
- auctionId: 'aid'
+ auctionId: 'aid',
+ getTIDs() {
+ return [this.auctionId, this.transactionId]
+ }
}
]
- }, addBidResponseStub, doneStub, ajaxStub, onTimelyResponseStub, wrappedCallback);
-
- sinon.assert.calledWithMatch(activityRules.isActivityAllowed, ACTIVITY_TRANSMIT_TID, {
- componentType: MODULE_TYPE_BIDDER,
- componentName: 'mockBidder'
+ };
+ activityRules.isActivityAllowed.callsFake(() => false);
+ spec.isBidRequestValid.returns(true);
+ spec.buildRequests.callsFake((reqs, bidderReq) => {
+ expect(bidderReq.getAID()).to.eql('aid');
+ expect(reqs[0].getTIDs()).to.eql(['aid', 'tid']);
+ done();
});
- sinon.assert.calledWithMatch(addBidResponseStub, sinon.match.any, {
- transactionId: 'tid',
- auctionId: 'aid'
- })
- });
+ newBidder(spec).callBids(bidderRequest, addBidResponseStub, doneStub, ajaxStub, onTimelyResponseStub, wrappedCallback);
+ })
});
- it('should not be hidden from request methods', (done) => {
- const bidderRequest = {
- bidderCode: 'mockBidder',
- auctionId: 'aid',
- getAID() { return this.auctionId },
- bids: [
- {
- adUnitCode: 'mockAU',
- bidId: 'bid',
- transactionId: 'tid',
- auctionId: 'aid',
- getTIDs() {
- return [this.auctionId, this.transactionId]
- }
- }
- ]
- };
- activityRules.isActivityAllowed.callsFake(() => false);
- spec.isBidRequestValid.returns(true);
- spec.buildRequests.callsFake((reqs, bidderReq) => {
- expect(bidderReq.getAID()).to.eql('aid');
- expect(reqs[0].getTIDs()).to.eql(['aid', 'tid']);
- done();
- });
- newBidder(spec).callBids(bidderRequest, addBidResponseStub, doneStub, ajaxStub, onTimelyResponseStub, wrappedCallback);
- })
- });
-
- it('should handle bad bid requests gracefully', function () {
- const bidder = newBidder(spec);
-
- spec.getUserSyncs.returns([]);
+ it('should handle bad bid requests gracefully', function () {
+ const bidder = newBidder(spec);
- bidder.callBids({});
- bidder.callBids({ bids: 'nothing useful' }, addBidResponseStub, doneStub, ajaxStub, onTimelyResponseStub, wrappedCallback);
+ spec.getUserSyncs.returns([]);
- expect(ajaxStub.called).to.equal(false);
- expect(spec.isBidRequestValid.called).to.equal(false);
- expect(spec.buildRequests.called).to.equal(false);
- expect(spec.interpretResponse.called).to.equal(false);
- });
+ bidder.callBids({});
+ bidder.callBids({ bids: 'nothing useful' }, addBidResponseStub, doneStub, ajaxStub, onTimelyResponseStub, wrappedCallback);
- it('should call buildRequests(bidRequest) the params are valid', function () {
- const bidder = newBidder(spec);
+ expect(ajaxStub.called).to.equal(false);
+ expect(spec.isBidRequestValid.called).to.equal(false);
+ expect(spec.buildRequests.called).to.equal(false);
+ expect(spec.interpretResponse.called).to.equal(false);
+ });
- spec.isBidRequestValid.returns(true);
- spec.buildRequests.returns([]);
+ it('should call buildRequests(bidRequest) the params are valid', function () {
+ const bidder = newBidder(spec);
- bidder.callBids(MOCK_BIDS_REQUEST, addBidResponseStub, doneStub, ajaxStub, onTimelyResponseStub, wrappedCallback);
+ spec.isBidRequestValid.returns(true);
+ spec.buildRequests.returns([]);
- expect(ajaxStub.called).to.equal(false);
- expect(spec.isBidRequestValid.calledTwice).to.equal(true);
- expect(spec.buildRequests.calledOnce).to.equal(true);
- expect(spec.buildRequests.firstCall.args[0]).to.deep.equal(MOCK_BIDS_REQUEST.bids);
- });
+ bidder.callBids(MOCK_BIDS_REQUEST, addBidResponseStub, doneStub, ajaxStub, onTimelyResponseStub, wrappedCallback);
- it('should not call buildRequests the params are invalid', function () {
- const bidder = newBidder(spec);
+ expect(ajaxStub.called).to.equal(false);
+ expect(spec.isBidRequestValid.calledTwice).to.equal(true);
+ expect(spec.buildRequests.calledOnce).to.equal(true);
+ expect(spec.buildRequests.firstCall.args[0]).to.deep.equal(MOCK_BIDS_REQUEST.bids);
+ });
- spec.isBidRequestValid.returns(false);
- spec.buildRequests.returns([]);
+ it('should not call buildRequests the params are invalid', function () {
+ const bidder = newBidder(spec);
- bidder.callBids(MOCK_BIDS_REQUEST, addBidResponseStub, doneStub, ajaxStub, onTimelyResponseStub, wrappedCallback);
+ spec.isBidRequestValid.returns(false);
+ spec.buildRequests.returns([]);
- expect(ajaxStub.called).to.equal(false);
- expect(spec.isBidRequestValid.calledTwice).to.equal(true);
- expect(spec.buildRequests.called).to.equal(false);
- });
+ bidder.callBids(MOCK_BIDS_REQUEST, addBidResponseStub, doneStub, ajaxStub, onTimelyResponseStub, wrappedCallback);
- it('should filter out invalid bids before calling buildRequests', function () {
- const bidder = newBidder(spec);
+ expect(ajaxStub.called).to.equal(false);
+ expect(spec.isBidRequestValid.calledTwice).to.equal(true);
+ expect(spec.buildRequests.called).to.equal(false);
+ });
- spec.isBidRequestValid.onFirstCall().returns(true);
- spec.isBidRequestValid.onSecondCall().returns(false);
- spec.buildRequests.returns([]);
+ it('should filter out invalid bids before calling buildRequests', function () {
+ const bidder = newBidder(spec);
- bidder.callBids(MOCK_BIDS_REQUEST, addBidResponseStub, doneStub, ajaxStub, onTimelyResponseStub, wrappedCallback);
+ spec.isBidRequestValid.onFirstCall().returns(true);
+ spec.isBidRequestValid.onSecondCall().returns(false);
+ spec.buildRequests.returns([]);
- expect(ajaxStub.called).to.equal(false);
- expect(spec.isBidRequestValid.calledTwice).to.equal(true);
- expect(spec.buildRequests.calledOnce).to.equal(true);
- expect(spec.buildRequests.firstCall.args[0]).to.deep.equal([MOCK_BIDS_REQUEST.bids[0]]);
- });
+ bidder.callBids(MOCK_BIDS_REQUEST, addBidResponseStub, doneStub, ajaxStub, onTimelyResponseStub, wrappedCallback);
- it('should make no server requests if the spec doesn\'t return any', function () {
- const bidder = newBidder(spec);
+ expect(ajaxStub.called).to.equal(false);
+ expect(spec.isBidRequestValid.calledTwice).to.equal(true);
+ expect(spec.buildRequests.calledOnce).to.equal(true);
+ expect(spec.buildRequests.firstCall.args[0]).to.deep.equal([MOCK_BIDS_REQUEST.bids[0]]);
+ });
- spec.isBidRequestValid.returns(true);
- spec.buildRequests.returns([]);
+ it('should make no server requests if the spec doesn\'t return any', function () {
+ const bidder = newBidder(spec);
- bidder.callBids(MOCK_BIDS_REQUEST, addBidResponseStub, doneStub, ajaxStub, onTimelyResponseStub, wrappedCallback);
+ spec.isBidRequestValid.returns(true);
+ spec.buildRequests.returns([]);
- expect(ajaxStub.called).to.equal(false);
- });
+ bidder.callBids(MOCK_BIDS_REQUEST, addBidResponseStub, doneStub, ajaxStub, onTimelyResponseStub, wrappedCallback);
- it('should make the appropriate POST request', function () {
- const bidder = newBidder(spec);
- const url = 'test.url.com';
- const data = { arg: 2 };
- spec.isBidRequestValid.returns(true);
- spec.buildRequests.returns({
- method: 'POST',
- url: url,
- data: data
+ expect(ajaxStub.called).to.equal(false);
});
- bidder.callBids(MOCK_BIDS_REQUEST, addBidResponseStub, doneStub, ajaxStub, onTimelyResponseStub, wrappedCallback);
+ it('should make the appropriate POST request', function () {
+ const bidder = newBidder(spec);
+ const url = 'test.url.com';
+ const data = { arg: 2 };
+ spec.isBidRequestValid.returns(true);
+ spec.buildRequests.returns({
+ method: 'POST',
+ url: url,
+ data: data
+ });
- expect(ajaxStub.calledOnce).to.equal(true);
- expect(ajaxStub.firstCall.args[0]).to.equal(url);
- expect(ajaxStub.firstCall.args[2]).to.equal(JSON.stringify(data));
- sinon.assert.match(ajaxStub.firstCall.args[3], {
- method: 'POST',
- contentType: 'text/plain',
- withCredentials: true
- });
- });
+ bidder.callBids(MOCK_BIDS_REQUEST, addBidResponseStub, doneStub, ajaxStub, onTimelyResponseStub, wrappedCallback);
- it('should make the appropriate POST request when options are passed', function () {
- const bidder = newBidder(spec);
- const url = 'test.url.com';
- const data = { arg: 2 };
- const options = { contentType: 'application/json' };
- spec.isBidRequestValid.returns(true);
- spec.buildRequests.returns({
- method: 'POST',
- url: url,
- data: data,
- options: options
+ expect(ajaxStub.calledOnce).to.equal(true);
+ expect(ajaxStub.firstCall.args[0]).to.equal(url);
+ expect(ajaxStub.firstCall.args[2]).to.equal(JSON.stringify(data));
+ sinon.assert.match(ajaxStub.firstCall.args[3], {
+ method: 'POST',
+ contentType: 'text/plain',
+ withCredentials: true
+ });
});
- bidder.callBids(MOCK_BIDS_REQUEST, addBidResponseStub, doneStub, ajaxStub, onTimelyResponseStub, wrappedCallback);
+ it('should make the appropriate POST request when options are passed', function () {
+ const bidder = newBidder(spec);
+ const url = 'test.url.com';
+ const data = { arg: 2 };
+ const options = { contentType: 'application/json' };
+ spec.isBidRequestValid.returns(true);
+ spec.buildRequests.returns({
+ method: 'POST',
+ url: url,
+ data: data,
+ options: options
+ });
- expect(ajaxStub.calledOnce).to.equal(true);
- expect(ajaxStub.firstCall.args[0]).to.equal(url);
- expect(ajaxStub.firstCall.args[2]).to.equal(JSON.stringify(data));
- sinon.assert.match(ajaxStub.firstCall.args[3], {
- method: 'POST',
- contentType: 'application/json',
- withCredentials: true
- })
- });
+ bidder.callBids(MOCK_BIDS_REQUEST, addBidResponseStub, doneStub, ajaxStub, onTimelyResponseStub, wrappedCallback);
- it('should make the appropriate GET request', function () {
- const bidder = newBidder(spec);
- const url = 'test.url.com';
- const data = { arg: 2 };
- spec.isBidRequestValid.returns(true);
- spec.buildRequests.returns({
- method: 'GET',
- url: url,
- data: data
+ expect(ajaxStub.calledOnce).to.equal(true);
+ expect(ajaxStub.firstCall.args[0]).to.equal(url);
+ expect(ajaxStub.firstCall.args[2]).to.equal(JSON.stringify(data));
+ sinon.assert.match(ajaxStub.firstCall.args[3], {
+ method: 'POST',
+ contentType: 'application/json',
+ withCredentials: true
+ })
});
- bidder.callBids(MOCK_BIDS_REQUEST, addBidResponseStub, doneStub, ajaxStub, onTimelyResponseStub, wrappedCallback);
+ it('should make the appropriate GET request', function () {
+ const bidder = newBidder(spec);
+ const url = 'test.url.com';
+ const data = { arg: 2 };
+ spec.isBidRequestValid.returns(true);
+ spec.buildRequests.returns({
+ method: 'GET',
+ url: url,
+ data: data
+ });
- expect(ajaxStub.calledOnce).to.equal(true);
- expect(ajaxStub.firstCall.args[0]).to.equal(`${url}?arg=2`);
- expect(ajaxStub.firstCall.args[2]).to.be.undefined;
- sinon.assert.match(ajaxStub.firstCall.args[3], {
- method: 'GET',
- withCredentials: true
- })
- });
+ bidder.callBids(MOCK_BIDS_REQUEST, addBidResponseStub, doneStub, ajaxStub, onTimelyResponseStub, wrappedCallback);
- it('should make the appropriate GET request when options are passed', function () {
- const bidder = newBidder(spec);
- const url = 'test.url.com';
- const data = { arg: 2 };
- const opt = { withCredentials: false }
- spec.isBidRequestValid.returns(true);
- spec.buildRequests.returns({
- method: 'GET',
- url: url,
- data: data,
- options: opt
+ expect(ajaxStub.calledOnce).to.equal(true);
+ expect(ajaxStub.firstCall.args[0]).to.equal(`${url}?arg=2`);
+ expect(ajaxStub.firstCall.args[2]).to.be.undefined;
+ sinon.assert.match(ajaxStub.firstCall.args[3], {
+ method: 'GET',
+ withCredentials: true
+ })
});
- bidder.callBids(MOCK_BIDS_REQUEST, addBidResponseStub, doneStub, ajaxStub, onTimelyResponseStub, wrappedCallback);
-
- expect(ajaxStub.calledOnce).to.equal(true);
- expect(ajaxStub.firstCall.args[0]).to.equal(`${url}?arg=2`);
- expect(ajaxStub.firstCall.args[2]).to.be.undefined;
- sinon.assert.match(ajaxStub.firstCall.args[3], {
- method: 'GET',
- withCredentials: false
- })
- });
-
- it('should make multiple calls if the spec returns them', function () {
- const bidder = newBidder(spec);
- const url = 'test.url.com';
- const data = { arg: 2 };
- spec.isBidRequestValid.returns(true);
- spec.buildRequests.returns([
- {
- method: 'POST',
- url: url,
- data: data
- },
- {
+ it('should make the appropriate GET request when options are passed', function () {
+ const bidder = newBidder(spec);
+ const url = 'test.url.com';
+ const data = { arg: 2 };
+ const opt = { withCredentials: false }
+ spec.isBidRequestValid.returns(true);
+ spec.buildRequests.returns({
method: 'GET',
url: url,
- data: data
- }
- ]);
-
- bidder.callBids(MOCK_BIDS_REQUEST, addBidResponseStub, doneStub, ajaxStub, onTimelyResponseStub, wrappedCallback);
+ data: data,
+ options: opt
+ });
- expect(ajaxStub.calledTwice).to.equal(true);
- });
+ bidder.callBids(MOCK_BIDS_REQUEST, addBidResponseStub, doneStub, ajaxStub, onTimelyResponseStub, wrappedCallback);
- describe('browsingTopics ajax option', () => {
- let transmitUfpdAllowed, bidder;
- beforeEach(() => {
- activityRules.isActivityAllowed.reset();
- activityRules.isActivityAllowed.callsFake((activity) => activity === ACTIVITY_TRANSMIT_UFPD ? transmitUfpdAllowed : true);
- bidder = newBidder(spec);
- spec.isBidRequestValid.returns(true);
+ expect(ajaxStub.calledOnce).to.equal(true);
+ expect(ajaxStub.firstCall.args[0]).to.equal(`${url}?arg=2`);
+ expect(ajaxStub.firstCall.args[2]).to.be.undefined;
+ sinon.assert.match(ajaxStub.firstCall.args[3], {
+ method: 'GET',
+ withCredentials: false
+ })
});
- it(`should be set to false when adapter sets browsingTopics = false`, () => {
- transmitUfpdAllowed = true;
+ it('should make multiple calls if the spec returns them', function () {
+ const bidder = newBidder(spec);
+ const url = 'test.url.com';
+ const data = { arg: 2 };
+ spec.isBidRequestValid.returns(true);
spec.buildRequests.returns([
+ {
+ method: 'POST',
+ url: url,
+ data: data
+ },
{
method: 'GET',
- url: 'url',
- options: {
- browsingTopics: false
- }
+ url: url,
+ data: data
}
]);
+
bidder.callBids(MOCK_BIDS_REQUEST, addBidResponseStub, doneStub, ajaxStub, onTimelyResponseStub, wrappedCallback);
- sinon.assert.calledWith(ajaxStub, 'url', sinon.match.any, sinon.match.any, sinon.match({
- browsingTopics: false
- }));
+
+ expect(ajaxStub.calledTwice).to.equal(true);
});
- Object.entries({
- 'allowed': true,
- 'not allowed': false
- }).forEach(([t, allow]) => {
- it(`should be set to ${allow} when transmitUfpd is ${t}`, () => {
- transmitUfpdAllowed = allow;
+ describe('browsingTopics ajax option', () => {
+ let transmitUfpdAllowed, bidder, origBS;
+ before(() => {
+ origBS = window.$$PREBID_GLOBAL$$.bidderSettings;
+ })
+
+ after(() => {
+ window.$$PREBID_GLOBAL$$.bidderSettings = origBS;
+ });
+
+ beforeEach(() => {
+ activityRules.isActivityAllowed.reset();
+ activityRules.isActivityAllowed.callsFake((activity) => activity === ACTIVITY_TRANSMIT_UFPD ? transmitUfpdAllowed : true);
+ bidder = newBidder(spec);
+ spec.isBidRequestValid.returns(true);
+ });
+
+ it(`should be set to false when adapter sets browsingTopics = false`, () => {
+ transmitUfpdAllowed = true;
spec.buildRequests.returns([
{
method: 'GET',
- url: '1',
- },
- {
- method: 'POST',
- url: '2',
- data: {}
- },
- {
- method: 'GET',
- url: '3',
+ url: 'url',
options: {
- browsingTopics: true
- }
- },
- {
- method: 'POST',
- url: '4',
- data: {},
- options: {
- browsingTopics: true
+ browsingTopics: false
}
}
]);
bidder.callBids(MOCK_BIDS_REQUEST, addBidResponseStub, doneStub, ajaxStub, onTimelyResponseStub, wrappedCallback);
- ['1', '2', '3', '4'].forEach(url => {
- sinon.assert.calledWith(
- ajaxStub,
- url,
- sinon.match.any,
- sinon.match.any,
- sinon.match({browsingTopics: allow})
- );
- });
+ sinon.assert.calledWith(ajaxStub, 'url', sinon.match.any, sinon.match.any, sinon.match({
+ browsingTopics: false
+ }));
});
+
+ Object.entries({
+ 'omitted': [undefined, true],
+ 'enabled': [true, true],
+ 'disabled': [false, false]
+ }).forEach(([t, [topicsHeader, enabled]]) => {
+ describe(`when bidderSettings.topicsHeader is ${t}`, () => {
+ beforeEach(() => {
+ window.$$PREBID_GLOBAL$$.bidderSettings = {
+ [CODE]: {
+ topicsHeader: topicsHeader
+ }
+ }
+ });
+
+ afterEach(() => {
+ delete window.$$PREBID_GLOBAL$$.bidderSettings[CODE];
+ });
+
+ Object.entries({
+ 'allowed': true,
+ 'not allowed': false
+ }).forEach(([t, allow]) => {
+ const shouldBeSet = allow && enabled;
+
+ it(`should be set to ${shouldBeSet} when transmitUfpd is ${t}`, () => {
+ transmitUfpdAllowed = allow;
+ spec.buildRequests.returns([
+ {
+ method: 'GET',
+ url: '1',
+ },
+ {
+ method: 'POST',
+ url: '2',
+ data: {}
+ },
+ {
+ method: 'GET',
+ url: '3',
+ options: {
+ browsingTopics: true
+ }
+ },
+ {
+ method: 'POST',
+ url: '4',
+ data: {},
+ options: {
+ browsingTopics: true
+ }
+ }
+ ]);
+ bidder.callBids(MOCK_BIDS_REQUEST, addBidResponseStub, doneStub, ajaxStub, onTimelyResponseStub, wrappedCallback);
+ ['1', '2', '3', '4'].forEach(url => {
+ sinon.assert.calledWith(
+ ajaxStub,
+ url,
+ sinon.match.any,
+ sinon.match.any,
+ sinon.match({browsingTopics: shouldBeSet})
+ );
+ });
+ });
+ });
+ })
+ })
});
- });
- it('should not add bids for each placement code if no requests are given', function () {
- const bidder = newBidder(spec);
+ it('should not add bids for each placement code if no requests are given', function () {
+ const bidder = newBidder(spec);
- spec.isBidRequestValid.returns(true);
- spec.buildRequests.returns([]);
- spec.interpretResponse.returns([]);
- spec.getUserSyncs.returns([]);
+ spec.isBidRequestValid.returns(true);
+ spec.buildRequests.returns([]);
+ spec.interpretResponse.returns([]);
+ spec.getUserSyncs.returns([]);
- bidder.callBids(MOCK_BIDS_REQUEST, addBidResponseStub, doneStub, ajaxStub, onTimelyResponseStub, wrappedCallback);
+ bidder.callBids(MOCK_BIDS_REQUEST, addBidResponseStub, doneStub, ajaxStub, onTimelyResponseStub, wrappedCallback);
- expect(addBidResponseStub.callCount).to.equal(0);
- });
+ expect(addBidResponseStub.callCount).to.equal(0);
+ });
- it('should emit BEFORE_BIDDER_HTTP events before network requests', function () {
- const bidder = newBidder(spec);
- const req = {
- method: 'POST',
- url: 'test.url.com',
- data: { arg: 2 }
- };
+ it('should emit BEFORE_BIDDER_HTTP events before network requests', function () {
+ const bidder = newBidder(spec);
+ const req = {
+ method: 'POST',
+ url: 'test.url.com',
+ data: { arg: 2 }
+ };
- spec.isBidRequestValid.returns(true);
- spec.buildRequests.returns([req, req]);
+ spec.isBidRequestValid.returns(true);
+ spec.buildRequests.returns([req, req]);
- const eventEmitterSpy = sinon.spy(events, 'emit');
- bidder.callBids(MOCK_BIDS_REQUEST, addBidResponseStub, doneStub, ajaxStub, onTimelyResponseStub, wrappedCallback);
+ const eventEmitterSpy = sinon.spy(events, 'emit');
+ bidder.callBids(MOCK_BIDS_REQUEST, addBidResponseStub, doneStub, ajaxStub, onTimelyResponseStub, wrappedCallback);
- expect(ajaxStub.calledTwice).to.equal(true);
- expect(eventEmitterSpy.getCalls()
- .filter(call => call.args[0] === CONSTANTS.EVENTS.BEFORE_BIDDER_HTTP)
- ).to.length(2);
+ expect(ajaxStub.calledTwice).to.equal(true);
+ expect(eventEmitterSpy.getCalls()
+ .filter(call => call.args[0] === CONSTANTS.EVENTS.BEFORE_BIDDER_HTTP)
+ ).to.length(2);
- eventEmitterSpy.restore();
+ eventEmitterSpy.restore();
+ });
});
- });
- describe('when the ajax call succeeds', function () {
- let ajaxStub;
- let userSyncStub;
- let logErrorSpy;
+ describe('when the ajax call succeeds', function () {
+ let ajaxStub;
+ let userSyncStub;
+ let logErrorSpy;
- beforeEach(function () {
- ajaxStub = sinon.stub(ajax, 'ajax').callsFake(function(url, callbacks) {
- const fakeResponse = sinon.stub();
- fakeResponse.returns('headerContent');
- callbacks.success('response body', { getResponseHeader: fakeResponse });
+ beforeEach(function () {
+ ajaxStub = sinon.stub(ajax, 'ajax').callsFake(function(url, callbacks) {
+ const fakeResponse = sinon.stub();
+ fakeResponse.returns('headerContent');
+ callbacks.success('response body', { getResponseHeader: fakeResponse });
+ });
+ addBidResponseStub.reset();
+ doneStub.resetBehavior();
+ userSyncStub = sinon.stub(userSync, 'registerSync')
+ logErrorSpy = sinon.spy(utils, 'logError');
});
- addBidResponseStub.reset();
- doneStub.resetBehavior();
- userSyncStub = sinon.stub(userSync, 'registerSync')
- logErrorSpy = sinon.spy(utils, 'logError');
- });
- afterEach(function () {
- ajaxStub.restore();
- userSyncStub.restore();
- utils.logError.restore();
- });
+ afterEach(function () {
+ ajaxStub.restore();
+ userSyncStub.restore();
+ utils.logError.restore();
+ });
- it('should call spec.interpretResponse() with the response content', function () {
- const bidder = newBidder(spec);
+ it('should call spec.interpretResponse() with the response content', function () {
+ const bidder = newBidder(spec);
- spec.isBidRequestValid.returns(true);
- spec.buildRequests.returns({
- method: 'POST',
- url: 'test.url.com',
- data: {}
+ spec.isBidRequestValid.returns(true);
+ spec.buildRequests.returns({
+ method: 'POST',
+ url: 'test.url.com',
+ data: {}
+ });
+ spec.getUserSyncs.returns([]);
+
+ bidder.callBids(MOCK_BIDS_REQUEST, addBidResponseStub, doneStub, ajaxStub, onTimelyResponseStub, wrappedCallback);
+
+ expect(spec.interpretResponse.calledOnce).to.equal(true);
+ const response = spec.interpretResponse.firstCall.args[0]
+ expect(response.body).to.equal('response body')
+ expect(response.headers.get('some-header')).to.equal('headerContent');
+ expect(spec.interpretResponse.firstCall.args[1]).to.deep.equal({
+ method: 'POST',
+ url: 'test.url.com',
+ data: {}
+ });
+ expect(doneStub.calledOnce).to.equal(true);
});
- spec.getUserSyncs.returns([]);
- bidder.callBids(MOCK_BIDS_REQUEST, addBidResponseStub, doneStub, ajaxStub, onTimelyResponseStub, wrappedCallback);
+ it('should call spec.interpretResponse() once for each request made', function () {
+ const bidder = newBidder(spec);
- expect(spec.interpretResponse.calledOnce).to.equal(true);
- const response = spec.interpretResponse.firstCall.args[0]
- expect(response.body).to.equal('response body')
- expect(response.headers.get('some-header')).to.equal('headerContent');
- expect(spec.interpretResponse.firstCall.args[1]).to.deep.equal({
- method: 'POST',
- url: 'test.url.com',
- data: {}
+ spec.isBidRequestValid.returns(true);
+ spec.buildRequests.returns([
+ {
+ method: 'POST',
+ url: 'test.url.com',
+ data: {}
+ },
+ {
+ method: 'POST',
+ url: 'test.url.com',
+ data: {}
+ },
+ ]);
+ spec.getUserSyncs.returns([]);
+
+ bidder.callBids(MOCK_BIDS_REQUEST, addBidResponseStub, doneStub, ajaxStub, onTimelyResponseStub, wrappedCallback);
+
+ expect(spec.interpretResponse.calledTwice).to.equal(true);
+ expect(doneStub.calledOnce).to.equal(true);
});
- expect(doneStub.calledOnce).to.equal(true);
- });
- it('should call spec.interpretResponse() once for each request made', function () {
- const bidder = newBidder(spec);
+ it('should only add bids for valid adUnit code into the auction, even if the bidder doesn\'t bid on all of them', function () {
+ const bidder = newBidder(spec);
- spec.isBidRequestValid.returns(true);
- spec.buildRequests.returns([
- {
+ const bid = {
+ creativeId: 'creative-id',
+ requestId: '1',
+ ad: 'ad-url.com',
+ cpm: 0.5,
+ height: 200,
+ width: 300,
+ adUnitCode: 'mock/placement',
+ currency: 'USD',
+ netRevenue: true,
+ ttl: 300,
+ bidderCode: 'sampleBidder',
+ sampleBidder: {advertiserId: '12345', networkId: '111222'}
+ };
+ const bidderRequest = Object.assign({}, MOCK_BIDS_REQUEST);
+ bidderRequest.bids[0].bidder = 'sampleBidder';
+ spec.isBidRequestValid.returns(true);
+ spec.buildRequests.returns({
method: 'POST',
url: 'test.url.com',
data: {}
- },
- {
+ });
+ spec.getUserSyncs.returns([]);
+
+ spec.interpretResponse.returns(bid);
+
+ bidder.callBids(bidderRequest, addBidResponseStub, doneStub, ajaxStub, onTimelyResponseStub, wrappedCallback);
+
+ expect(addBidResponseStub.calledOnce).to.equal(true);
+ expect(addBidResponseStub.firstCall.args[0]).to.equal('mock/placement');
+ let bidObject = addBidResponseStub.firstCall.args[1];
+ // checking the fields added by our code
+ expect(bidObject.originalCpm).to.equal(bid.cpm);
+ expect(bidObject.originalCurrency).to.equal(bid.currency);
+ expect(doneStub.calledOnce).to.equal(true);
+ expect(logErrorSpy.callCount).to.equal(0);
+ expect(bidObject.meta).to.exist;
+ expect(bidObject.meta).to.deep.equal({advertiserId: '12345', networkId: '111222'});
+ });
+
+ it('should call spec.getUserSyncs() with the response', function () {
+ const bidder = newBidder(spec);
+
+ spec.isBidRequestValid.returns(true);
+ spec.buildRequests.returns({
method: 'POST',
url: 'test.url.com',
data: {}
- },
- ]);
- spec.getUserSyncs.returns([]);
+ });
+ spec.getUserSyncs.returns([]);
- bidder.callBids(MOCK_BIDS_REQUEST, addBidResponseStub, doneStub, ajaxStub, onTimelyResponseStub, wrappedCallback);
+ bidder.callBids(MOCK_BIDS_REQUEST, addBidResponseStub, doneStub, ajaxStub, onTimelyResponseStub, wrappedCallback);
- expect(spec.interpretResponse.calledTwice).to.equal(true);
- expect(doneStub.calledOnce).to.equal(true);
- });
+ expect(spec.getUserSyncs.calledOnce).to.equal(true);
+ expect(spec.getUserSyncs.firstCall.args[1].length).to.equal(1);
+ expect(spec.getUserSyncs.firstCall.args[1][0].body).to.equal('response body');
+ expect(spec.getUserSyncs.firstCall.args[1][0].headers).to.have.property('get');
+ expect(spec.getUserSyncs.firstCall.args[1][0].headers.get).to.be.a('function');
+ });
- it('should only add bids for valid adUnit code into the auction, even if the bidder doesn\'t bid on all of them', function () {
- const bidder = newBidder(spec);
+ it('should register usersync pixels', function () {
+ const bidder = newBidder(spec);
- const bid = {
- creativeId: 'creative-id',
- requestId: '1',
- ad: 'ad-url.com',
- cpm: 0.5,
- height: 200,
- width: 300,
- adUnitCode: 'mock/placement',
- currency: 'USD',
- netRevenue: true,
- ttl: 300,
- bidderCode: 'sampleBidder',
- sampleBidder: {advertiserId: '12345', networkId: '111222'}
- };
- const bidderRequest = Object.assign({}, MOCK_BIDS_REQUEST);
- bidderRequest.bids[0].bidder = 'sampleBidder';
- spec.isBidRequestValid.returns(true);
- spec.buildRequests.returns({
- method: 'POST',
- url: 'test.url.com',
- data: {}
+ spec.isBidRequestValid.returns(false);
+ spec.buildRequests.returns([]);
+ spec.getUserSyncs.returns([{
+ type: 'iframe',
+ url: 'usersync.com'
+ }]);
+
+ bidder.callBids(MOCK_BIDS_REQUEST, addBidResponseStub, doneStub, ajaxStub, onTimelyResponseStub, wrappedCallback);
+
+ expect(userSyncStub.called).to.equal(true);
+ expect(userSyncStub.firstCall.args[0]).to.equal('iframe');
+ expect(userSyncStub.firstCall.args[1]).to.equal(spec.code);
+ expect(userSyncStub.firstCall.args[2]).to.equal('usersync.com');
});
- spec.getUserSyncs.returns([]);
- spec.interpretResponse.returns(bid);
+ it('should logError and reject bid when required bid response params are missing', function () {
+ const bidder = newBidder(spec);
- bidder.callBids(bidderRequest, addBidResponseStub, doneStub, ajaxStub, onTimelyResponseStub, wrappedCallback);
+ const bid = {
+ requestId: '1',
+ ad: 'ad-url.com',
+ cpm: 0.5,
+ height: 200,
+ width: 300,
+ placementCode: 'mock/placement'
+ };
+ spec.isBidRequestValid.returns(true);
+ spec.buildRequests.returns({
+ method: 'POST',
+ url: 'test.url.com',
+ data: {}
+ });
+ spec.getUserSyncs.returns([]);
- expect(addBidResponseStub.calledOnce).to.equal(true);
- expect(addBidResponseStub.firstCall.args[0]).to.equal('mock/placement');
- let bidObject = addBidResponseStub.firstCall.args[1];
- // checking the fields added by our code
- expect(bidObject.originalCpm).to.equal(bid.cpm);
- expect(bidObject.originalCurrency).to.equal(bid.currency);
- expect(doneStub.calledOnce).to.equal(true);
- expect(logErrorSpy.callCount).to.equal(0);
- expect(bidObject.meta).to.exist;
- expect(bidObject.meta).to.deep.equal({advertiserId: '12345', networkId: '111222'});
- });
+ spec.interpretResponse.returns(bid);
- it('should call spec.getUserSyncs() with the response', function () {
- const bidder = newBidder(spec);
+ bidder.callBids(MOCK_BIDS_REQUEST, addBidResponseStub, doneStub, ajaxStub, onTimelyResponseStub, wrappedCallback);
- spec.isBidRequestValid.returns(true);
- spec.buildRequests.returns({
- method: 'POST',
- url: 'test.url.com',
- data: {}
+ expect(logErrorSpy.calledOnce).to.equal(true);
+ expect(addBidResponseStub.reject.calledOnce).to.be.true;
});
- spec.getUserSyncs.returns([]);
- bidder.callBids(MOCK_BIDS_REQUEST, addBidResponseStub, doneStub, ajaxStub, onTimelyResponseStub, wrappedCallback);
+ it('should logError and reject bid when required response params are undefined', function () {
+ const bidder = newBidder(spec);
- expect(spec.getUserSyncs.calledOnce).to.equal(true);
- expect(spec.getUserSyncs.firstCall.args[1].length).to.equal(1);
- expect(spec.getUserSyncs.firstCall.args[1][0].body).to.equal('response body');
- expect(spec.getUserSyncs.firstCall.args[1][0].headers).to.have.property('get');
- expect(spec.getUserSyncs.firstCall.args[1][0].headers.get).to.be.a('function');
- });
+ const bid = {
+ 'ad': 'creative',
+ 'cpm': '1.99',
+ 'width': 300,
+ 'height': 250,
+ 'requestId': '1',
+ 'creativeId': 'some-id',
+ 'currency': undefined,
+ 'netRevenue': true,
+ 'ttl': 360
+ };
- it('should register usersync pixels', function () {
- const bidder = newBidder(spec);
+ spec.isBidRequestValid.returns(true);
+ spec.buildRequests.returns({
+ method: 'POST',
+ url: 'test.url.com',
+ data: {}
+ });
+ spec.getUserSyncs.returns([]);
- spec.isBidRequestValid.returns(false);
- spec.buildRequests.returns([]);
- spec.getUserSyncs.returns([{
- type: 'iframe',
- url: 'usersync.com'
- }]);
+ spec.interpretResponse.returns(bid);
- bidder.callBids(MOCK_BIDS_REQUEST, addBidResponseStub, doneStub, ajaxStub, onTimelyResponseStub, wrappedCallback);
+ bidder.callBids(MOCK_BIDS_REQUEST, addBidResponseStub, doneStub, ajaxStub, onTimelyResponseStub, wrappedCallback);
- expect(userSyncStub.called).to.equal(true);
- expect(userSyncStub.firstCall.args[0]).to.equal('iframe');
- expect(userSyncStub.firstCall.args[1]).to.equal(spec.code);
- expect(userSyncStub.firstCall.args[2]).to.equal('usersync.com');
- });
+ expect(logErrorSpy.calledOnce).to.equal(true);
+ expect(addBidResponseStub.reject.calledOnce).to.be.true;
+ });
- it('should logError and reject bid when required bid response params are missing', function () {
- const bidder = newBidder(spec);
+ it('should require requestId from interpretResponse', () => {
+ const bidder = newBidder(spec);
+ const bid = {
+ 'ad': 'creative',
+ 'cpm': '1.99',
+ 'creativeId': 'some-id',
+ 'currency': 'USD',
+ 'netRevenue': true,
+ 'ttl': 360
+ };
+ spec.isBidRequestValid.returns(true);
+ spec.buildRequests.returns({
+ method: 'POST',
+ url: 'test.url.com',
+ data: {}
+ });
+ spec.getUserSyncs.returns([]);
+ spec.interpretResponse.returns(bid);
- const bid = {
- requestId: '1',
- ad: 'ad-url.com',
- cpm: 0.5,
- height: 200,
- width: 300,
- placementCode: 'mock/placement'
+ bidder.callBids(MOCK_BIDS_REQUEST, addBidResponseStub, doneStub, ajaxStub, onTimelyResponseStub, wrappedCallback);
+
+ expect(addBidResponseStub.called).to.be.false;
+ expect(addBidResponseStub.reject.calledOnce).to.be.true;
+ });
+ });
+
+ describe('when the ajax call fails', function () {
+ let ajaxStub;
+ let callBidderErrorStub;
+ let eventEmitterStub;
+ let xhrErrorMock = {
+ status: 500,
+ statusText: 'Internal Server Error'
};
- spec.isBidRequestValid.returns(true);
- spec.buildRequests.returns({
- method: 'POST',
- url: 'test.url.com',
- data: {}
+
+ beforeEach(function () {
+ ajaxStub = sinon.stub(ajax, 'ajax').callsFake(function(url, callbacks) {
+ callbacks.error('ajax call failed.', xhrErrorMock);
+ });
+ callBidderErrorStub = sinon.stub(adapterManager, 'callBidderError');
+ eventEmitterStub = sinon.stub(events, 'emit');
+ addBidResponseStub.reset();
+ doneStub.reset();
});
- spec.getUserSyncs.returns([]);
- spec.interpretResponse.returns(bid);
+ afterEach(function () {
+ ajaxStub.restore();
+ callBidderErrorStub.restore();
+ eventEmitterStub.restore();
+ });
- bidder.callBids(MOCK_BIDS_REQUEST, addBidResponseStub, doneStub, ajaxStub, onTimelyResponseStub, wrappedCallback);
+ it('should not spec.interpretResponse()', function () {
+ const bidder = newBidder(spec);
- expect(logErrorSpy.calledOnce).to.equal(true);
- expect(addBidResponseStub.reject.calledOnce).to.be.true;
- });
+ spec.isBidRequestValid.returns(true);
+ spec.buildRequests.returns({
+ method: 'POST',
+ url: 'test.url.com',
+ data: {}
+ });
+ spec.getUserSyncs.returns([]);
- it('should logError and reject bid when required response params are undefined', function () {
- const bidder = newBidder(spec);
+ bidder.callBids(MOCK_BIDS_REQUEST, addBidResponseStub, doneStub, ajaxStub, onTimelyResponseStub, wrappedCallback);
- const bid = {
- 'ad': 'creative',
- 'cpm': '1.99',
- 'width': 300,
- 'height': 250,
- 'requestId': '1',
- 'creativeId': 'some-id',
- 'currency': undefined,
- 'netRevenue': true,
- 'ttl': 360
- };
+ expect(spec.interpretResponse.called).to.equal(false);
+ expect(doneStub.calledOnce).to.equal(true);
+ expect(callBidderErrorStub.calledOnce).to.equal(true);
+ expect(callBidderErrorStub.firstCall.args[0]).to.equal(CODE);
+ expect(callBidderErrorStub.firstCall.args[1]).to.equal(xhrErrorMock);
+ expect(callBidderErrorStub.firstCall.args[2]).to.equal(MOCK_BIDS_REQUEST);
+ sinon.assert.calledWith(eventEmitterStub, CONSTANTS.EVENTS.BIDDER_ERROR, {
+ error: xhrErrorMock,
+ bidderRequest: MOCK_BIDS_REQUEST
+ });
+ });
- spec.isBidRequestValid.returns(true);
- spec.buildRequests.returns({
- method: 'POST',
- url: 'test.url.com',
- data: {}
+ it('should not add bids for each adunit code into the auction', function () {
+ const bidder = newBidder(spec);
+
+ spec.isBidRequestValid.returns(true);
+ spec.buildRequests.returns({
+ method: 'POST',
+ url: 'test.url.com',
+ data: {}
+ });
+ spec.interpretResponse.returns([]);
+ spec.getUserSyncs.returns([]);
+
+ bidder.callBids(MOCK_BIDS_REQUEST, addBidResponseStub, doneStub, ajaxStub, onTimelyResponseStub, wrappedCallback);
+
+ expect(addBidResponseStub.callCount).to.equal(0);
+ expect(doneStub.calledOnce).to.equal(true);
+ expect(callBidderErrorStub.calledOnce).to.equal(true);
+ expect(callBidderErrorStub.firstCall.args[0]).to.equal(CODE);
+ expect(callBidderErrorStub.firstCall.args[1]).to.equal(xhrErrorMock);
+ expect(callBidderErrorStub.firstCall.args[2]).to.equal(MOCK_BIDS_REQUEST);
+ sinon.assert.calledWith(eventEmitterStub, CONSTANTS.EVENTS.BIDDER_ERROR, {
+ error: xhrErrorMock,
+ bidderRequest: MOCK_BIDS_REQUEST
+ });
});
- spec.getUserSyncs.returns([]);
- spec.interpretResponse.returns(bid);
+ it('should call spec.getUserSyncs() with no responses', function () {
+ const bidder = newBidder(spec);
- bidder.callBids(MOCK_BIDS_REQUEST, addBidResponseStub, doneStub, ajaxStub, onTimelyResponseStub, wrappedCallback);
+ spec.isBidRequestValid.returns(true);
+ spec.buildRequests.returns({
+ method: 'POST',
+ url: 'test.url.com',
+ data: {}
+ });
+ spec.getUserSyncs.returns([]);
- expect(logErrorSpy.calledOnce).to.equal(true);
- expect(addBidResponseStub.reject.calledOnce).to.be.true;
- });
+ bidder.callBids(MOCK_BIDS_REQUEST, addBidResponseStub, doneStub, ajaxStub, onTimelyResponseStub, wrappedCallback);
- it('should require requestId from interpretResponse', () => {
- const bidder = newBidder(spec);
- const bid = {
- 'ad': 'creative',
- 'cpm': '1.99',
- 'creativeId': 'some-id',
- 'currency': 'USD',
- 'netRevenue': true,
- 'ttl': 360
- };
- spec.isBidRequestValid.returns(true);
- spec.buildRequests.returns({
- method: 'POST',
- url: 'test.url.com',
- data: {}
+ expect(spec.getUserSyncs.calledOnce).to.equal(true);
+ expect(spec.getUserSyncs.firstCall.args[1]).to.deep.equal([]);
+ expect(doneStub.calledOnce).to.equal(true);
+ expect(callBidderErrorStub.calledOnce).to.equal(true);
+ expect(callBidderErrorStub.firstCall.args[0]).to.equal(CODE);
+ expect(callBidderErrorStub.firstCall.args[1]).to.equal(xhrErrorMock);
+ expect(callBidderErrorStub.firstCall.args[2]).to.equal(MOCK_BIDS_REQUEST);
+ sinon.assert.calledWith(eventEmitterStub, CONSTANTS.EVENTS.BIDDER_ERROR, {
+ error: xhrErrorMock,
+ bidderRequest: MOCK_BIDS_REQUEST
+ });
});
- spec.getUserSyncs.returns([]);
- spec.interpretResponse.returns(bid);
- bidder.callBids(MOCK_BIDS_REQUEST, addBidResponseStub, doneStub, ajaxStub, onTimelyResponseStub, wrappedCallback);
+ it('should call spec.getUserSyncs() with no responses', function () {
+ const bidder = newBidder(spec);
- expect(addBidResponseStub.called).to.be.false;
- expect(addBidResponseStub.reject.calledOnce).to.be.true;
+ spec.isBidRequestValid.returns(true);
+ spec.buildRequests.returns({
+ method: 'POST',
+ url: 'test.url.com',
+ data: {}
+ });
+ spec.getUserSyncs.returns([]);
+
+ bidder.callBids(MOCK_BIDS_REQUEST, addBidResponseStub, doneStub, ajaxStub, onTimelyResponseStub, wrappedCallback);
+
+ expect(spec.getUserSyncs.calledOnce).to.equal(true);
+ expect(spec.getUserSyncs.firstCall.args[1]).to.deep.equal([]);
+ expect(doneStub.calledOnce).to.equal(true);
+ expect(callBidderErrorStub.calledOnce).to.equal(true);
+ expect(callBidderErrorStub.firstCall.args[0]).to.equal(CODE);
+ expect(callBidderErrorStub.firstCall.args[1]).to.equal(xhrErrorMock);
+ expect(callBidderErrorStub.firstCall.args[2]).to.equal(MOCK_BIDS_REQUEST);
+ sinon.assert.calledWith(eventEmitterStub, CONSTANTS.EVENTS.BIDDER_ERROR, {
+ error: xhrErrorMock,
+ bidderRequest: MOCK_BIDS_REQUEST
+ });
+ });
});
});
- describe('when the ajax call fails', function () {
- let ajaxStub;
- let callBidderErrorStub;
- let eventEmitterStub;
- let xhrErrorMock = {
- status: 500,
- statusText: 'Internal Server Error'
- };
+ describe('registerBidder', function () {
+ let registerBidAdapterStub;
+ let aliasBidAdapterStub;
beforeEach(function () {
- ajaxStub = sinon.stub(ajax, 'ajax').callsFake(function(url, callbacks) {
- callbacks.error('ajax call failed.', xhrErrorMock);
- });
- callBidderErrorStub = sinon.stub(adapterManager, 'callBidderError');
- eventEmitterStub = sinon.stub(events, 'emit');
- addBidResponseStub.reset();
- doneStub.reset();
+ registerBidAdapterStub = sinon.stub(adapterManager, 'registerBidAdapter');
+ aliasBidAdapterStub = sinon.stub(adapterManager, 'aliasBidAdapter');
});
afterEach(function () {
- ajaxStub.restore();
- callBidderErrorStub.restore();
- eventEmitterStub.restore();
+ registerBidAdapterStub.restore();
+ aliasBidAdapterStub.restore();
});
- it('should not spec.interpretResponse()', function () {
- const bidder = newBidder(spec);
+ function newEmptySpec() {
+ return {
+ code: CODE,
+ isBidRequestValid: function() { },
+ buildRequests: function() { },
+ interpretResponse: function() { },
+ };
+ }
- spec.isBidRequestValid.returns(true);
- spec.buildRequests.returns({
- method: 'POST',
- url: 'test.url.com',
- data: {}
- });
- spec.getUserSyncs.returns([]);
-
- bidder.callBids(MOCK_BIDS_REQUEST, addBidResponseStub, doneStub, ajaxStub, onTimelyResponseStub, wrappedCallback);
-
- expect(spec.interpretResponse.called).to.equal(false);
- expect(doneStub.calledOnce).to.equal(true);
- expect(callBidderErrorStub.calledOnce).to.equal(true);
- expect(callBidderErrorStub.firstCall.args[0]).to.equal(CODE);
- expect(callBidderErrorStub.firstCall.args[1]).to.equal(xhrErrorMock);
- expect(callBidderErrorStub.firstCall.args[2]).to.equal(MOCK_BIDS_REQUEST);
- sinon.assert.calledWith(eventEmitterStub, CONSTANTS.EVENTS.BIDDER_ERROR, {
- error: xhrErrorMock,
- bidderRequest: MOCK_BIDS_REQUEST
- });
- });
+ it('should register a bidder with the adapterManager', function () {
+ registerBidder(newEmptySpec());
+ expect(registerBidAdapterStub.calledOnce).to.equal(true);
+ expect(registerBidAdapterStub.firstCall.args[0]).to.have.property('callBids');
+ expect(registerBidAdapterStub.firstCall.args[0].callBids).to.be.a('function');
- it('should not add bids for each adunit code into the auction', function () {
- const bidder = newBidder(spec);
+ expect(registerBidAdapterStub.firstCall.args[1]).to.equal(CODE);
+ expect(registerBidAdapterStub.firstCall.args[2]).to.be.undefined;
+ });
- spec.isBidRequestValid.returns(true);
- spec.buildRequests.returns({
- method: 'POST',
- url: 'test.url.com',
- data: {}
- });
- spec.interpretResponse.returns([]);
- spec.getUserSyncs.returns([]);
-
- bidder.callBids(MOCK_BIDS_REQUEST, addBidResponseStub, doneStub, ajaxStub, onTimelyResponseStub, wrappedCallback);
-
- expect(addBidResponseStub.callCount).to.equal(0);
- expect(doneStub.calledOnce).to.equal(true);
- expect(callBidderErrorStub.calledOnce).to.equal(true);
- expect(callBidderErrorStub.firstCall.args[0]).to.equal(CODE);
- expect(callBidderErrorStub.firstCall.args[1]).to.equal(xhrErrorMock);
- expect(callBidderErrorStub.firstCall.args[2]).to.equal(MOCK_BIDS_REQUEST);
- sinon.assert.calledWith(eventEmitterStub, CONSTANTS.EVENTS.BIDDER_ERROR, {
- error: xhrErrorMock,
- bidderRequest: MOCK_BIDS_REQUEST
- });
+ it('should register a bidder with the appropriate mediaTypes', function () {
+ const thisSpec = Object.assign(newEmptySpec(), { supportedMediaTypes: ['video'] });
+ registerBidder(thisSpec);
+ expect(registerBidAdapterStub.calledOnce).to.equal(true);
+ expect(registerBidAdapterStub.firstCall.args[2]).to.deep.equal({supportedMediaTypes: ['video']});
});
- it('should call spec.getUserSyncs() with no responses', function () {
- const bidder = newBidder(spec);
+ it('should register bidders with the appropriate aliases', function () {
+ const thisSpec = Object.assign(newEmptySpec(), { aliases: ['foo', 'bar'] });
+ registerBidder(thisSpec);
- spec.isBidRequestValid.returns(true);
- spec.buildRequests.returns({
- method: 'POST',
- url: 'test.url.com',
- data: {}
- });
- spec.getUserSyncs.returns([]);
-
- bidder.callBids(MOCK_BIDS_REQUEST, addBidResponseStub, doneStub, ajaxStub, onTimelyResponseStub, wrappedCallback);
-
- expect(spec.getUserSyncs.calledOnce).to.equal(true);
- expect(spec.getUserSyncs.firstCall.args[1]).to.deep.equal([]);
- expect(doneStub.calledOnce).to.equal(true);
- expect(callBidderErrorStub.calledOnce).to.equal(true);
- expect(callBidderErrorStub.firstCall.args[0]).to.equal(CODE);
- expect(callBidderErrorStub.firstCall.args[1]).to.equal(xhrErrorMock);
- expect(callBidderErrorStub.firstCall.args[2]).to.equal(MOCK_BIDS_REQUEST);
- sinon.assert.calledWith(eventEmitterStub, CONSTANTS.EVENTS.BIDDER_ERROR, {
- error: xhrErrorMock,
- bidderRequest: MOCK_BIDS_REQUEST
- });
- });
+ expect(registerBidAdapterStub.calledThrice).to.equal(true);
- it('should call spec.getUserSyncs() with no responses', function () {
- const bidder = newBidder(spec);
+ // Make sure our later calls don't override the bidder code from previous calls.
+ expect(registerBidAdapterStub.firstCall.args[0].getBidderCode()).to.equal(CODE);
+ expect(registerBidAdapterStub.secondCall.args[0].getBidderCode()).to.equal('foo')
+ expect(registerBidAdapterStub.thirdCall.args[0].getBidderCode()).to.equal('bar')
- spec.isBidRequestValid.returns(true);
- spec.buildRequests.returns({
- method: 'POST',
- url: 'test.url.com',
- data: {}
- });
- spec.getUserSyncs.returns([]);
-
- bidder.callBids(MOCK_BIDS_REQUEST, addBidResponseStub, doneStub, ajaxStub, onTimelyResponseStub, wrappedCallback);
-
- expect(spec.getUserSyncs.calledOnce).to.equal(true);
- expect(spec.getUserSyncs.firstCall.args[1]).to.deep.equal([]);
- expect(doneStub.calledOnce).to.equal(true);
- expect(callBidderErrorStub.calledOnce).to.equal(true);
- expect(callBidderErrorStub.firstCall.args[0]).to.equal(CODE);
- expect(callBidderErrorStub.firstCall.args[1]).to.equal(xhrErrorMock);
- expect(callBidderErrorStub.firstCall.args[2]).to.equal(MOCK_BIDS_REQUEST);
- sinon.assert.calledWith(eventEmitterStub, CONSTANTS.EVENTS.BIDDER_ERROR, {
- error: xhrErrorMock,
- bidderRequest: MOCK_BIDS_REQUEST
- });
+ expect(registerBidAdapterStub.firstCall.args[1]).to.equal(CODE);
+ expect(registerBidAdapterStub.secondCall.args[1]).to.equal('foo')
+ expect(registerBidAdapterStub.thirdCall.args[1]).to.equal('bar')
});
- });
-});
-describe('registerBidder', function () {
- let registerBidAdapterStub;
- let aliasBidAdapterStub;
+ it('should register alias with their gvlid', function() {
+ const aliases = [
+ {
+ code: 'foo',
+ gvlid: 1
+ },
+ {
+ code: 'bar',
+ gvlid: 2
+ },
+ {
+ code: 'baz'
+ }
+ ]
+ const thisSpec = Object.assign(newEmptySpec(), { aliases: aliases });
+ registerBidder(thisSpec);
- beforeEach(function () {
- registerBidAdapterStub = sinon.stub(adapterManager, 'registerBidAdapter');
- aliasBidAdapterStub = sinon.stub(adapterManager, 'aliasBidAdapter');
- });
+ expect(registerBidAdapterStub.getCall(1).args[0].getSpec().gvlid).to.equal(1);
+ expect(registerBidAdapterStub.getCall(2).args[0].getSpec().gvlid).to.equal(2);
+ expect(registerBidAdapterStub.getCall(3).args[0].getSpec().gvlid).to.equal(undefined);
+ })
- afterEach(function () {
- registerBidAdapterStub.restore();
- aliasBidAdapterStub.restore();
- });
+ it('should register alias with skipPbsAliasing', function() {
+ const aliases = [
+ {
+ code: 'foo',
+ skipPbsAliasing: true
+ },
+ {
+ code: 'bar',
+ skipPbsAliasing: false
+ },
+ {
+ code: 'baz'
+ }
+ ]
+ const thisSpec = Object.assign(newEmptySpec(), { aliases: aliases });
+ registerBidder(thisSpec);
- function newEmptySpec() {
- return {
- code: CODE,
- isBidRequestValid: function() { },
- buildRequests: function() { },
- interpretResponse: function() { },
- };
- }
-
- it('should register a bidder with the adapterManager', function () {
- registerBidder(newEmptySpec());
- expect(registerBidAdapterStub.calledOnce).to.equal(true);
- expect(registerBidAdapterStub.firstCall.args[0]).to.have.property('callBids');
- expect(registerBidAdapterStub.firstCall.args[0].callBids).to.be.a('function');
-
- expect(registerBidAdapterStub.firstCall.args[1]).to.equal(CODE);
- expect(registerBidAdapterStub.firstCall.args[2]).to.be.undefined;
- });
+ expect(registerBidAdapterStub.getCall(1).args[0].getSpec().skipPbsAliasing).to.equal(true);
+ expect(registerBidAdapterStub.getCall(2).args[0].getSpec().skipPbsAliasing).to.equal(false);
+ expect(registerBidAdapterStub.getCall(3).args[0].getSpec().skipPbsAliasing).to.equal(undefined);
+ })
+ })
- it('should register a bidder with the appropriate mediaTypes', function () {
- const thisSpec = Object.assign(newEmptySpec(), { supportedMediaTypes: ['video'] });
- registerBidder(thisSpec);
- expect(registerBidAdapterStub.calledOnce).to.equal(true);
- expect(registerBidAdapterStub.firstCall.args[2]).to.deep.equal({supportedMediaTypes: ['video']});
- });
+ describe('validate bid response: ', function () {
+ let spec;
+ let indexStub, adUnits, bidderRequests;
+ let addBidResponseStub;
+ let doneStub;
+ let ajaxStub;
+ let logErrorSpy;
+
+ let bids = [{
+ 'ad': 'creative',
+ 'cpm': '1.99',
+ 'width': 300,
+ 'height': 250,
+ 'requestId': '1',
+ 'creativeId': 'some-id',
+ 'currency': 'USD',
+ 'netRevenue': true,
+ 'ttl': 360
+ }];
+
+ beforeEach(function () {
+ spec = {
+ code: CODE,
+ isBidRequestValid: sinon.stub(),
+ buildRequests: sinon.stub(),
+ interpretResponse: sinon.stub(),
+ };
- it('should register bidders with the appropriate aliases', function () {
- const thisSpec = Object.assign(newEmptySpec(), { aliases: ['foo', 'bar'] });
- registerBidder(thisSpec);
+ spec.isBidRequestValid.returns(true);
+ spec.buildRequests.returns({
+ method: 'POST',
+ url: 'test.url.com',
+ data: {}
+ });
- expect(registerBidAdapterStub.calledThrice).to.equal(true);
+ addBidResponseStub = sinon.stub();
+ addBidResponseStub.reject = sinon.stub();
+ doneStub = sinon.stub();
+ ajaxStub = sinon.stub(ajax, 'ajax').callsFake(function(url, callbacks) {
+ const fakeResponse = sinon.stub();
+ fakeResponse.returns('headerContent');
+ callbacks.success('response body', { getResponseHeader: fakeResponse });
+ });
+ logErrorSpy = sinon.spy(utils, 'logError');
+ indexStub = sinon.stub(auctionManager, 'index');
+ adUnits = [];
+ bidderRequests = [];
+ indexStub.get(() => stubAuctionIndex({adUnits: adUnits, bidderRequests: bidderRequests}))
+ });
- // Make sure our later calls don't override the bidder code from previous calls.
- expect(registerBidAdapterStub.firstCall.args[0].getBidderCode()).to.equal(CODE);
- expect(registerBidAdapterStub.secondCall.args[0].getBidderCode()).to.equal('foo')
- expect(registerBidAdapterStub.thirdCall.args[0].getBidderCode()).to.equal('bar')
+ afterEach(function () {
+ ajaxStub.restore();
+ logErrorSpy.restore();
+ indexStub.restore;
+ });
- expect(registerBidAdapterStub.firstCall.args[1]).to.equal(CODE);
- expect(registerBidAdapterStub.secondCall.args[1]).to.equal('foo')
- expect(registerBidAdapterStub.thirdCall.args[1]).to.equal('bar')
- });
+ if (FEATURES.NATIVE) {
+ it('should add native bids that do have required assets', function () {
+ adUnits = [{
+ transactionId: 'au',
+ nativeParams: {
+ title: {'required': true},
+ }
+ }]
+ decorateAdUnitsWithNativeParams(adUnits);
+ let bidRequest = {
+ bids: [{
+ bidId: '1',
+ auctionId: 'first-bid-id',
+ adUnitCode: 'mock/placement',
+ transactionId: 'au',
+ params: {
+ param: 5
+ },
+ mediaType: 'native',
+ }]
+ };
- it('should register alias with their gvlid', function() {
- const aliases = [
- {
- code: 'foo',
- gvlid: 1
- },
- {
- code: 'bar',
- gvlid: 2
- },
- {
- code: 'baz'
- }
- ]
- const thisSpec = Object.assign(newEmptySpec(), { aliases: aliases });
- registerBidder(thisSpec);
+ let bids1 = Object.assign({},
+ bids[0],
+ {
+ 'mediaType': 'native',
+ 'native': {
+ 'title': 'Native Creative',
+ 'clickUrl': 'https://www.link.example',
+ }
+ }
+ );
- expect(registerBidAdapterStub.getCall(1).args[0].getSpec().gvlid).to.equal(1);
- expect(registerBidAdapterStub.getCall(2).args[0].getSpec().gvlid).to.equal(2);
- expect(registerBidAdapterStub.getCall(3).args[0].getSpec().gvlid).to.equal(undefined);
- })
+ const bidder = newBidder(spec);
- it('should register alias with skipPbsAliasing', function() {
- const aliases = [
- {
- code: 'foo',
- skipPbsAliasing: true
- },
- {
- code: 'bar',
- skipPbsAliasing: false
- },
- {
- code: 'baz'
- }
- ]
- const thisSpec = Object.assign(newEmptySpec(), { aliases: aliases });
- registerBidder(thisSpec);
+ spec.interpretResponse.returns(bids1);
+ bidder.callBids(bidRequest, addBidResponseStub, doneStub, ajaxStub, onTimelyResponseStub, wrappedCallback);
- expect(registerBidAdapterStub.getCall(1).args[0].getSpec().skipPbsAliasing).to.equal(true);
- expect(registerBidAdapterStub.getCall(2).args[0].getSpec().skipPbsAliasing).to.equal(false);
- expect(registerBidAdapterStub.getCall(3).args[0].getSpec().skipPbsAliasing).to.equal(undefined);
- })
-})
+ expect(addBidResponseStub.calledOnce).to.equal(true);
+ expect(addBidResponseStub.firstCall.args[0]).to.equal('mock/placement');
+ expect(logErrorSpy.callCount).to.equal(0);
+ });
-describe('validate bid response: ', function () {
- let spec;
- let indexStub, adUnits, bidderRequests;
- let addBidResponseStub;
- let doneStub;
- let ajaxStub;
- let logErrorSpy;
-
- let bids = [{
- 'ad': 'creative',
- 'cpm': '1.99',
- 'width': 300,
- 'height': 250,
- 'requestId': '1',
- 'creativeId': 'some-id',
- 'currency': 'USD',
- 'netRevenue': true,
- 'ttl': 360
- }];
-
- beforeEach(function () {
- spec = {
- code: CODE,
- isBidRequestValid: sinon.stub(),
- buildRequests: sinon.stub(),
- interpretResponse: sinon.stub(),
- };
-
- spec.isBidRequestValid.returns(true);
- spec.buildRequests.returns({
- method: 'POST',
- url: 'test.url.com',
- data: {}
- });
+ it('should not add native bids that do not have required assets', function () {
+ adUnits = [{
+ transactionId: 'au',
+ nativeParams: {
+ title: {'required': true},
+ },
+ }];
+ decorateAdUnitsWithNativeParams(adUnits);
+ let bidRequest = {
+ bids: [{
+ bidId: '1',
+ auctionId: 'first-bid-id',
+ adUnitCode: 'mock/placement',
+ transactionId: 'au',
+ params: {
+ param: 5
+ },
+ mediaType: 'native',
+ }]
+ };
+ let bids1 = Object.assign({},
+ bids[0],
+ {
+ bidderCode: CODE,
+ mediaType: 'native',
+ native: {
+ title: undefined,
+ clickUrl: 'https://www.link.example',
+ }
+ }
+ );
- addBidResponseStub = sinon.stub();
- addBidResponseStub.reject = sinon.stub();
- doneStub = sinon.stub();
- ajaxStub = sinon.stub(ajax, 'ajax').callsFake(function(url, callbacks) {
- const fakeResponse = sinon.stub();
- fakeResponse.returns('headerContent');
- callbacks.success('response body', { getResponseHeader: fakeResponse });
- });
- logErrorSpy = sinon.spy(utils, 'logError');
- indexStub = sinon.stub(auctionManager, 'index');
- adUnits = [];
- bidderRequests = [];
- indexStub.get(() => stubAuctionIndex({adUnits: adUnits, bidderRequests: bidderRequests}))
- });
+ const bidder = newBidder(spec);
+ spec.interpretResponse.returns(bids1);
+ bidder.callBids(bidRequest, addBidResponseStub, doneStub, ajaxStub, onTimelyResponseStub, wrappedCallback);
- afterEach(function () {
- ajaxStub.restore();
- logErrorSpy.restore();
- indexStub.restore;
- });
+ expect(addBidResponseStub.called).to.equal(false);
+ expect(addBidResponseStub.reject.calledOnce).to.be.true;
+ expect(logErrorSpy.calledWithMatch('Ignoring bid: Native bid missing some required properties.')).to.equal(true);
+ });
+ }
- if (FEATURES.NATIVE) {
- it('should add native bids that do have required assets', function () {
+ it('should add bid when renderer is present on outstream bids', function () {
adUnits = [{
transactionId: 'au',
- nativeParams: {
- title: {'required': true},
+ mediaTypes: {
+ video: {context: 'outstream'}
}
}]
- decorateAdUnitsWithNativeParams(adUnits);
let bidRequest = {
bids: [{
bidId: '1',
auctionId: 'first-bid-id',
- adUnitCode: 'mock/placement',
transactionId: 'au',
+ adUnitCode: 'mock/placement',
params: {
param: 5
},
- mediaType: 'native',
}]
};
let bids1 = Object.assign({},
bids[0],
{
- 'mediaType': 'native',
- 'native': {
- 'title': 'Native Creative',
- 'clickUrl': 'https://www.link.example',
- }
+ bidderCode: CODE,
+ mediaType: 'video',
+ renderer: {render: () => true, url: 'render.js'},
}
);
@@ -1095,413 +1206,335 @@ describe('validate bid response: ', function () {
expect(logErrorSpy.callCount).to.equal(0);
});
- it('should not add native bids that do not have required assets', function () {
- adUnits = [{
- transactionId: 'au',
- nativeParams: {
- title: {'required': true},
- },
- }];
- decorateAdUnitsWithNativeParams(adUnits);
+ it('should add banner bids that have no width or height but single adunit size', function () {
let bidRequest = {
bids: [{
+ bidder: CODE,
bidId: '1',
auctionId: 'first-bid-id',
adUnitCode: 'mock/placement',
- transactionId: 'au',
params: {
param: 5
},
- mediaType: 'native',
+ sizes: [[300, 250]],
}]
};
+ bidderRequests = [bidRequest];
let bids1 = Object.assign({},
bids[0],
{
- bidderCode: CODE,
- mediaType: 'native',
- native: {
- title: undefined,
- clickUrl: 'https://www.link.example',
- }
+ width: undefined,
+ height: undefined
}
);
const bidder = newBidder(spec);
+
spec.interpretResponse.returns(bids1);
bidder.callBids(bidRequest, addBidResponseStub, doneStub, ajaxStub, onTimelyResponseStub, wrappedCallback);
- expect(addBidResponseStub.called).to.equal(false);
- expect(addBidResponseStub.reject.calledOnce).to.be.true;
- expect(logErrorSpy.calledWithMatch('Ignoring bid: Native bid missing some required properties.')).to.equal(true);
+ expect(addBidResponseStub.calledOnce).to.equal(true);
+ expect(addBidResponseStub.firstCall.args[0]).to.equal('mock/placement');
+ expect(logErrorSpy.callCount).to.equal(0);
});
- }
-
- it('should add bid when renderer is present on outstream bids', function () {
- adUnits = [{
- transactionId: 'au',
- mediaTypes: {
- video: {context: 'outstream'}
- }
- }]
- let bidRequest = {
- bids: [{
- bidId: '1',
- auctionId: 'first-bid-id',
- transactionId: 'au',
- adUnitCode: 'mock/placement',
- params: {
- param: 5
- },
- }]
- };
-
- let bids1 = Object.assign({},
- bids[0],
- {
- bidderCode: CODE,
- mediaType: 'video',
- renderer: {render: () => true, url: 'render.js'},
- }
- );
-
- const bidder = newBidder(spec);
-
- spec.interpretResponse.returns(bids1);
- bidder.callBids(bidRequest, addBidResponseStub, doneStub, ajaxStub, onTimelyResponseStub, wrappedCallback);
-
- expect(addBidResponseStub.calledOnce).to.equal(true);
- expect(addBidResponseStub.firstCall.args[0]).to.equal('mock/placement');
- expect(logErrorSpy.callCount).to.equal(0);
- });
-
- it('should add banner bids that have no width or height but single adunit size', function () {
- let bidRequest = {
- bids: [{
- bidder: CODE,
- bidId: '1',
- auctionId: 'first-bid-id',
- adUnitCode: 'mock/placement',
- params: {
- param: 5
- },
- sizes: [[300, 250]],
- }]
- };
- bidderRequests = [bidRequest];
- let bids1 = Object.assign({},
- bids[0],
- {
- width: undefined,
- height: undefined
- }
- );
-
- const bidder = newBidder(spec);
-
- spec.interpretResponse.returns(bids1);
- bidder.callBids(bidRequest, addBidResponseStub, doneStub, ajaxStub, onTimelyResponseStub, wrappedCallback);
-
- expect(addBidResponseStub.calledOnce).to.equal(true);
- expect(addBidResponseStub.firstCall.args[0]).to.equal('mock/placement');
- expect(logErrorSpy.callCount).to.equal(0);
- });
-
- it('should disregard auctionId/transactionId set by the adapter', () => {
- let bidderRequest = {
- bids: [{
- bidder: CODE,
- bidId: '1',
- auctionId: 'aid',
- transactionId: 'tid',
- adUnitCode: 'au',
- }]
- };
- const bidder = newBidder(spec);
- spec.interpretResponse.returns(Object.assign({}, bids[0], {transactionId: 'ignored', auctionId: 'ignored'}));
- bidder.callBids(bidderRequest, addBidResponseStub, doneStub, ajaxStub, onTimelyResponseStub, wrappedCallback);
- sinon.assert.calledWith(addBidResponseStub, sinon.match.any, sinon.match({
- transactionId: 'tid',
- auctionId: 'aid'
- }));
- })
-
- describe(' Check for alternateBiddersList ', function() {
- let bidRequest;
- let bids1;
- let logWarnSpy;
- let bidderSettingStub, aliasRegistryStub;
- let aliasRegistry;
- beforeEach(function () {
- bidRequest = {
+ it('should disregard auctionId/transactionId set by the adapter', () => {
+ let bidderRequest = {
bids: [{
- bidId: '1',
bidder: CODE,
- auctionId: 'first-bid-id',
- adUnitCode: 'mock/placement',
- transactionId: 'au',
+ bidId: '1',
+ auctionId: 'aid',
+ transactionId: 'tid',
+ adUnitCode: 'au',
}]
};
+ const bidder = newBidder(spec);
+ spec.interpretResponse.returns(Object.assign({}, bids[0], {transactionId: 'ignored', auctionId: 'ignored'}));
+ bidder.callBids(bidderRequest, addBidResponseStub, doneStub, ajaxStub, onTimelyResponseStub, wrappedCallback);
+ sinon.assert.calledWith(addBidResponseStub, sinon.match.any, sinon.match({
+ transactionId: 'tid',
+ auctionId: 'aid'
+ }));
+ })
- bids1 = Object.assign({},
- bids[0],
- {
- bidderCode: 'validalternatebidder',
- adapterCode: 'knownadapter1'
- }
- );
- logWarnSpy = sinon.spy(utils, 'logWarn');
- bidderSettingStub = sinon.stub(bidderSettings, 'get');
- aliasRegistry = {};
- aliasRegistryStub = sinon.stub(adapterManager, 'aliasRegistry');
- aliasRegistryStub.get(() => aliasRegistry);
- });
+ describe(' Check for alternateBiddersList ', function() {
+ let bidRequest;
+ let bids1;
+ let logWarnSpy;
+ let bidderSettingStub, aliasRegistryStub;
+ let aliasRegistry;
- afterEach(function () {
- logWarnSpy.restore();
- bidderSettingStub.restore();
- aliasRegistryStub.restore();
- });
+ beforeEach(function () {
+ bidRequest = {
+ bids: [{
+ bidId: '1',
+ bidder: CODE,
+ auctionId: 'first-bid-id',
+ adUnitCode: 'mock/placement',
+ transactionId: 'au',
+ }]
+ };
- it('should log warning when bidder is unknown and allowAlternateBidderCodes flag is false', function () {
- bidderSettingStub.returns(false);
+ bids1 = Object.assign({},
+ bids[0],
+ {
+ bidderCode: 'validalternatebidder',
+ adapterCode: 'knownadapter1'
+ }
+ );
+ logWarnSpy = sinon.spy(utils, 'logWarn');
+ bidderSettingStub = sinon.stub(bidderSettings, 'get');
+ aliasRegistry = {};
+ aliasRegistryStub = sinon.stub(adapterManager, 'aliasRegistry');
+ aliasRegistryStub.get(() => aliasRegistry);
+ });
- const bidder = newBidder(spec);
- spec.interpretResponse.returns(bids1);
- bidder.callBids(bidRequest, addBidResponseStub, doneStub, ajaxStub, onTimelyResponseStub, wrappedCallback);
+ afterEach(function () {
+ logWarnSpy.restore();
+ bidderSettingStub.restore();
+ aliasRegistryStub.restore();
+ });
- expect(addBidResponseStub.called).to.equal(false);
- expect(addBidResponseStub.reject.calledOnce).to.be.true;
- expect(logWarnSpy.callCount).to.equal(1);
- });
+ it('should log warning when bidder is unknown and allowAlternateBidderCodes flag is false', function () {
+ bidderSettingStub.returns(false);
- it('should reject the bid, when allowAlternateBidderCodes flag is undefined (default should be false)', function () {
- bidderSettingStub.returns(undefined);
+ const bidder = newBidder(spec);
+ spec.interpretResponse.returns(bids1);
+ bidder.callBids(bidRequest, addBidResponseStub, doneStub, ajaxStub, onTimelyResponseStub, wrappedCallback);
- const bidder = newBidder(spec);
- spec.interpretResponse.returns(bids1);
- bidder.callBids(bidRequest, addBidResponseStub, doneStub, ajaxStub, onTimelyResponseStub, wrappedCallback);
+ expect(addBidResponseStub.called).to.equal(false);
+ expect(addBidResponseStub.reject.calledOnce).to.be.true;
+ expect(logWarnSpy.callCount).to.equal(1);
+ });
- expect(addBidResponseStub.called).to.equal(false);
- expect(addBidResponseStub.reject.calledOnce).to.be.true;
- });
+ it('should reject the bid, when allowAlternateBidderCodes flag is undefined (default should be false)', function () {
+ bidderSettingStub.returns(undefined);
- it('should log warning when the particular bidder is not specified in allowedAlternateBidderCodes and allowAlternateBidderCodes flag is true', function () {
- bidderSettingStub.withArgs(CODE, 'allowAlternateBidderCodes').returns(true);
- bidderSettingStub.withArgs(CODE, 'allowedAlternateBidderCodes').returns(['invalidAlternateBidder02']);
+ const bidder = newBidder(spec);
+ spec.interpretResponse.returns(bids1);
+ bidder.callBids(bidRequest, addBidResponseStub, doneStub, ajaxStub, onTimelyResponseStub, wrappedCallback);
- const bidder = newBidder(spec);
- spec.interpretResponse.returns(bids1);
- bidder.callBids(bidRequest, addBidResponseStub, doneStub, ajaxStub, onTimelyResponseStub, wrappedCallback);
+ expect(addBidResponseStub.called).to.equal(false);
+ expect(addBidResponseStub.reject.calledOnce).to.be.true;
+ });
- expect(addBidResponseStub.called).to.equal(false);
- expect(addBidResponseStub.reject.calledOnce).to.be.true;
- expect(logWarnSpy.callCount).to.equal(1);
- });
+ it('should log warning when the particular bidder is not specified in allowedAlternateBidderCodes and allowAlternateBidderCodes flag is true', function () {
+ bidderSettingStub.withArgs(CODE, 'allowAlternateBidderCodes').returns(true);
+ bidderSettingStub.withArgs(CODE, 'allowedAlternateBidderCodes').returns(['invalidAlternateBidder02']);
- it('should accept the bid, when allowedAlternateBidderCodes is empty and allowAlternateBidderCodes flag is true', function () {
- bidderSettingStub.withArgs(CODE, 'allowAlternateBidderCodes').returns(true);
- bidderSettingStub.withArgs(CODE, 'allowedAlternateBidderCodes').returns();
+ const bidder = newBidder(spec);
+ spec.interpretResponse.returns(bids1);
+ bidder.callBids(bidRequest, addBidResponseStub, doneStub, ajaxStub, onTimelyResponseStub, wrappedCallback);
- const bidder = newBidder(spec);
- spec.interpretResponse.returns(bids1);
- bidder.callBids(bidRequest, addBidResponseStub, doneStub, ajaxStub, onTimelyResponseStub, wrappedCallback);
+ expect(addBidResponseStub.called).to.equal(false);
+ expect(addBidResponseStub.reject.calledOnce).to.be.true;
+ expect(logWarnSpy.callCount).to.equal(1);
+ });
- expect(addBidResponseStub.calledOnce).to.equal(true);
- expect(logWarnSpy.callCount).to.equal(0);
- expect(logErrorSpy.callCount).to.equal(0);
- });
+ it('should accept the bid, when allowedAlternateBidderCodes is empty and allowAlternateBidderCodes flag is true', function () {
+ bidderSettingStub.withArgs(CODE, 'allowAlternateBidderCodes').returns(true);
+ bidderSettingStub.withArgs(CODE, 'allowedAlternateBidderCodes').returns();
- it('should accept the bid, when allowedAlternateBidderCodes is marked as * and allowAlternateBidderCodes flag is true', function () {
- bidderSettingStub.withArgs(CODE, 'allowAlternateBidderCodes').returns(true);
- bidderSettingStub.withArgs(CODE, 'allowedAlternateBidderCodes').returns(['*']);
+ const bidder = newBidder(spec);
+ spec.interpretResponse.returns(bids1);
+ bidder.callBids(bidRequest, addBidResponseStub, doneStub, ajaxStub, onTimelyResponseStub, wrappedCallback);
- const bidder = newBidder(spec);
- spec.interpretResponse.returns(bids1);
- bidder.callBids(bidRequest, addBidResponseStub, doneStub, ajaxStub, onTimelyResponseStub, wrappedCallback);
+ expect(addBidResponseStub.calledOnce).to.equal(true);
+ expect(logWarnSpy.callCount).to.equal(0);
+ expect(logErrorSpy.callCount).to.equal(0);
+ });
- expect(addBidResponseStub.calledOnce).to.equal(true);
- expect(logWarnSpy.callCount).to.equal(0);
- expect(logErrorSpy.callCount).to.equal(0);
- });
+ it('should accept the bid, when allowedAlternateBidderCodes is marked as * and allowAlternateBidderCodes flag is true', function () {
+ bidderSettingStub.withArgs(CODE, 'allowAlternateBidderCodes').returns(true);
+ bidderSettingStub.withArgs(CODE, 'allowedAlternateBidderCodes').returns(['*']);
- it('should accept the bid, when allowedAlternateBidderCodes is marked as * (with space) and allowAlternateBidderCodes flag is true', function () {
- bidderSettingStub.withArgs(CODE, 'allowAlternateBidderCodes').returns(true);
- bidderSettingStub.withArgs(CODE, 'allowedAlternateBidderCodes').returns([' * ']);
+ const bidder = newBidder(spec);
+ spec.interpretResponse.returns(bids1);
+ bidder.callBids(bidRequest, addBidResponseStub, doneStub, ajaxStub, onTimelyResponseStub, wrappedCallback);
- const bidder = newBidder(spec);
- spec.interpretResponse.returns(bids1);
- bidder.callBids(bidRequest, addBidResponseStub, doneStub, ajaxStub, onTimelyResponseStub, wrappedCallback);
+ expect(addBidResponseStub.calledOnce).to.equal(true);
+ expect(logWarnSpy.callCount).to.equal(0);
+ expect(logErrorSpy.callCount).to.equal(0);
+ });
- expect(addBidResponseStub.calledOnce).to.equal(true);
- expect(logWarnSpy.callCount).to.equal(0);
- expect(logErrorSpy.callCount).to.equal(0);
- });
+ it('should accept the bid, when allowedAlternateBidderCodes is marked as * (with space) and allowAlternateBidderCodes flag is true', function () {
+ bidderSettingStub.withArgs(CODE, 'allowAlternateBidderCodes').returns(true);
+ bidderSettingStub.withArgs(CODE, 'allowedAlternateBidderCodes').returns([' * ']);
+
+ const bidder = newBidder(spec);
+ spec.interpretResponse.returns(bids1);
+ bidder.callBids(bidRequest, addBidResponseStub, doneStub, ajaxStub, onTimelyResponseStub, wrappedCallback);
- it('should not accept the bid, when allowedAlternateBidderCodes is marked as empty array and allowAlternateBidderCodes flag is true', function () {
- bidderSettingStub.withArgs(CODE, 'allowAlternateBidderCodes').returns(true);
- bidderSettingStub.withArgs(CODE, 'allowedAlternateBidderCodes').returns([]);
+ expect(addBidResponseStub.calledOnce).to.equal(true);
+ expect(logWarnSpy.callCount).to.equal(0);
+ expect(logErrorSpy.callCount).to.equal(0);
+ });
- const bidder = newBidder(spec);
- spec.interpretResponse.returns(bids1);
- bidder.callBids(bidRequest, addBidResponseStub, doneStub, ajaxStub, onTimelyResponseStub, wrappedCallback);
+ it('should not accept the bid, when allowedAlternateBidderCodes is marked as empty array and allowAlternateBidderCodes flag is true', function () {
+ bidderSettingStub.withArgs(CODE, 'allowAlternateBidderCodes').returns(true);
+ bidderSettingStub.withArgs(CODE, 'allowedAlternateBidderCodes').returns([]);
- expect(addBidResponseStub.called).to.equal(false);
- expect(addBidResponseStub.reject.calledOnce).to.be.true;
- expect(logWarnSpy.callCount).to.equal(1);
- });
+ const bidder = newBidder(spec);
+ spec.interpretResponse.returns(bids1);
+ bidder.callBids(bidRequest, addBidResponseStub, doneStub, ajaxStub, onTimelyResponseStub, wrappedCallback);
- it('should accept the bid, when allowedAlternateBidderCodes contains bidder name and allowAlternateBidderCodes flag is true', function () {
- bidderSettingStub.withArgs(CODE, 'allowAlternateBidderCodes').returns(true);
- bidderSettingStub.withArgs(CODE, 'allowedAlternateBidderCodes').returns(['validAlternateBidder']);
+ expect(addBidResponseStub.called).to.equal(false);
+ expect(addBidResponseStub.reject.calledOnce).to.be.true;
+ expect(logWarnSpy.callCount).to.equal(1);
+ });
- const bidder = newBidder(spec);
- spec.interpretResponse.returns(bids1);
- bidder.callBids(bidRequest, addBidResponseStub, doneStub, ajaxStub, onTimelyResponseStub, wrappedCallback);
+ it('should accept the bid, when allowedAlternateBidderCodes contains bidder name and allowAlternateBidderCodes flag is true', function () {
+ bidderSettingStub.withArgs(CODE, 'allowAlternateBidderCodes').returns(true);
+ bidderSettingStub.withArgs(CODE, 'allowedAlternateBidderCodes').returns(['validAlternateBidder']);
- expect(addBidResponseStub.called).to.equal(true);
- expect(logWarnSpy.callCount).to.equal(0);
- expect(logErrorSpy.callCount).to.equal(0);
- });
+ const bidder = newBidder(spec);
+ spec.interpretResponse.returns(bids1);
+ bidder.callBids(bidRequest, addBidResponseStub, doneStub, ajaxStub, onTimelyResponseStub, wrappedCallback);
- it('should not accept the bid, when bidder is an alias but bidderSetting is missing for the bidder. It should fallback to standard setting and reject the bid', function () {
- bidderSettingStub.withArgs(CODE, 'allowAlternateBidderCodes').returns(false);
- aliasRegistry = {'validAlternateBidder': CODE};
+ expect(addBidResponseStub.called).to.equal(true);
+ expect(logWarnSpy.callCount).to.equal(0);
+ expect(logErrorSpy.callCount).to.equal(0);
+ });
- const bidder = newBidder(spec);
- spec.interpretResponse.returns(bids1);
- bidder.callBids(bidRequest, addBidResponseStub, doneStub, ajaxStub, onTimelyResponseStub, wrappedCallback);
+ it('should not accept the bid, when bidder is an alias but bidderSetting is missing for the bidder. It should fallback to standard setting and reject the bid', function () {
+ bidderSettingStub.withArgs(CODE, 'allowAlternateBidderCodes').returns(false);
+ aliasRegistry = {'validAlternateBidder': CODE};
- expect(addBidResponseStub.called).to.equal(false);
- expect(logWarnSpy.callCount).to.equal(1);
- expect(addBidResponseStub.reject.calledOnce).to.be.true;
- });
+ const bidder = newBidder(spec);
+ spec.interpretResponse.returns(bids1);
+ bidder.callBids(bidRequest, addBidResponseStub, doneStub, ajaxStub, onTimelyResponseStub, wrappedCallback);
- it('should not accept the bid, when bidderSetting is missing for the bidder. It should fallback to standard setting and reject the bid', function () {
- bidderSettingStub.withArgs(CODE, 'allowAlternateBidderCodes').returns(false);
+ expect(addBidResponseStub.called).to.equal(false);
+ expect(logWarnSpy.callCount).to.equal(1);
+ expect(addBidResponseStub.reject.calledOnce).to.be.true;
+ });
- const bidder = newBidder(spec);
- spec.interpretResponse.returns(bids1);
- bidder.callBids(bidRequest, addBidResponseStub, doneStub, ajaxStub, onTimelyResponseStub, wrappedCallback);
+ it('should not accept the bid, when bidderSetting is missing for the bidder. It should fallback to standard setting and reject the bid', function () {
+ bidderSettingStub.withArgs(CODE, 'allowAlternateBidderCodes').returns(false);
+
+ const bidder = newBidder(spec);
+ spec.interpretResponse.returns(bids1);
+ bidder.callBids(bidRequest, addBidResponseStub, doneStub, ajaxStub, onTimelyResponseStub, wrappedCallback);
- expect(addBidResponseStub.called).to.equal(false);
- expect(addBidResponseStub.reject.calledOnce).to.be.true;
- expect(logWarnSpy.callCount).to.equal(1);
+ expect(addBidResponseStub.called).to.equal(false);
+ expect(addBidResponseStub.reject.calledOnce).to.be.true;
+ expect(logWarnSpy.callCount).to.equal(1);
+ });
});
- });
- describe('when interpretResponse returns BidderAuctionResponse', function() {
- const bidRequest = {
- bids: [{
+ describe('when interpretResponse returns BidderAuctionResponse', function() {
+ const bidRequest = {
+ auctionId: 'aid',
+ bids: [{
+ bidId: '1',
+ bidder: CODE,
+ auctionId: 'aid',
+ adUnitCode: 'mock/placement',
+ transactionId: 'au',
+ }]
+ };
+ const fledgeAuctionConfig = {
bidId: '1',
- bidder: CODE,
- auctionId: 'first-bid-id',
- adUnitCode: 'mock/placement',
- transactionId: 'au',
- }]
- };
- const fledgeAuctionConfig = {
- bidId: '1',
- config: {
- foo: 'bar'
- }
- }
- describe('when response has FLEDGE auction config', function() {
- let fledgeStub;
-
- function fledgeHook(next, ...args) {
- fledgeStub(...args);
+ config: {
+ foo: 'bar'
+ }
}
+ describe('when response has FLEDGE auction config', function() {
+ let fledgeStub;
- before(() => {
- addComponentAuction.before(fledgeHook);
- });
+ function fledgeHook(next, ...args) {
+ fledgeStub(...args);
+ }
- after(() => {
- addComponentAuction.getHooks({hook: fledgeHook}).remove();
- })
+ before(() => {
+ addComponentAuction.before(fledgeHook);
+ });
- beforeEach(function () {
- fledgeStub = sinon.stub();
- });
+ after(() => {
+ addComponentAuction.getHooks({hook: fledgeHook}).remove();
+ })
- it('should unwrap bids', function() {
- const bidder = newBidder(spec);
- spec.interpretResponse.returns({
- bids: bids,
- fledgeAuctionConfigs: []
+ beforeEach(function () {
+ fledgeStub = sinon.stub();
});
- bidder.callBids(bidRequest, addBidResponseStub, doneStub, ajaxStub, onTimelyResponseStub, wrappedCallback);
- expect(addBidResponseStub.calledOnce).to.equal(true);
- expect(addBidResponseStub.firstCall.args[0]).to.equal('mock/placement');
- });
- it('should call fledgeManager with FLEDGE configs', function() {
- const bidder = newBidder(spec);
- spec.interpretResponse.returns({
- bids: bids,
- fledgeAuctionConfigs: [fledgeAuctionConfig]
+ it('should unwrap bids', function() {
+ const bidder = newBidder(spec);
+ spec.interpretResponse.returns({
+ bids: bids,
+ fledgeAuctionConfigs: []
+ });
+ bidder.callBids(bidRequest, addBidResponseStub, doneStub, ajaxStub, onTimelyResponseStub, wrappedCallback);
+ expect(addBidResponseStub.calledOnce).to.equal(true);
+ expect(addBidResponseStub.firstCall.args[0]).to.equal('mock/placement');
});
- bidder.callBids(bidRequest, addBidResponseStub, doneStub, ajaxStub, onTimelyResponseStub, wrappedCallback);
- expect(fledgeStub.calledOnce).to.equal(true);
- sinon.assert.calledWith(fledgeStub, 'mock/placement', fledgeAuctionConfig.config);
- expect(addBidResponseStub.calledOnce).to.equal(true);
- expect(addBidResponseStub.firstCall.args[0]).to.equal('mock/placement');
- })
+ it('should call fledgeManager with FLEDGE configs', function() {
+ const bidder = newBidder(spec);
+ spec.interpretResponse.returns({
+ bids: bids,
+ fledgeAuctionConfigs: [fledgeAuctionConfig]
+ });
+ bidder.callBids(bidRequest, addBidResponseStub, doneStub, ajaxStub, onTimelyResponseStub, wrappedCallback);
- it('should call fledgeManager with FLEDGE configs even if no bids returned', function() {
- const bidder = newBidder(spec);
- spec.interpretResponse.returns({
- bids: [],
- fledgeAuctionConfigs: [fledgeAuctionConfig]
- });
- bidder.callBids(bidRequest, addBidResponseStub, doneStub, ajaxStub, onTimelyResponseStub, wrappedCallback);
+ expect(fledgeStub.calledOnce).to.equal(true);
+ sinon.assert.calledWith(fledgeStub, bidRequest.bids[0], fledgeAuctionConfig.config);
+ expect(addBidResponseStub.calledOnce).to.equal(true);
+ expect(addBidResponseStub.firstCall.args[0]).to.equal('mock/placement');
+ })
- expect(fledgeStub.calledOnce).to.be.true;
- sinon.assert.calledWith(fledgeStub, 'mock/placement', fledgeAuctionConfig.config);
- expect(addBidResponseStub.calledOnce).to.equal(false);
+ it('should call fledgeManager with FLEDGE configs even if no bids returned', function() {
+ const bidder = newBidder(spec);
+ spec.interpretResponse.returns({
+ bids: [],
+ fledgeAuctionConfigs: [fledgeAuctionConfig]
+ });
+ bidder.callBids(bidRequest, addBidResponseStub, doneStub, ajaxStub, onTimelyResponseStub, wrappedCallback);
+
+ expect(fledgeStub.calledOnce).to.be.true;
+ sinon.assert.calledWith(fledgeStub, bidRequest.bids[0], fledgeAuctionConfig.config);
+ expect(addBidResponseStub.calledOnce).to.equal(false);
+ })
})
})
- })
-});
+ });
-describe('bid response isValid', () => {
- describe('size check', () => {
- let req, index;
+ describe('bid response isValid', () => {
+ describe('size check', () => {
+ let req, index;
- beforeEach(() => {
- req = {
- ...MOCK_BIDS_REQUEST.bids[0],
- mediaTypes: {
- banner: {
- sizes: [[1, 2], [3, 4]]
+ beforeEach(() => {
+ req = {
+ ...MOCK_BIDS_REQUEST.bids[0],
+ mediaTypes: {
+ banner: {
+ sizes: [[1, 2], [3, 4]]
+ }
}
}
- }
- });
+ });
- function mkResponse(width, height) {
- return {
- requestId: req.bidId,
- width,
- height,
- cpm: 1,
- ttl: 60,
- creativeId: '123',
- netRevenue: true,
- currency: 'USD',
- mediaType: 'banner',
+ function mkResponse(width, height) {
+ return {
+ requestId: req.bidId,
+ width,
+ height,
+ cpm: 1,
+ ttl: 60,
+ creativeId: '123',
+ netRevenue: true,
+ currency: 'USD',
+ mediaType: 'banner',
+ }
}
- }
- function checkValid(bid) {
- return isValid('au', bid, {index: stubAuctionIndex({bidRequests: [req]})});
- }
+ function checkValid(bid) {
+ return isValid('au', bid, {index: stubAuctionIndex({bidRequests: [req]})});
+ }
- it('should succeed when response has a size that was in request', () => {
- expect(checkValid(mkResponse(3, 4))).to.be.true;
- });
- })
-});
+ it('should succeed when response has a size that was in request', () => {
+ expect(checkValid(mkResponse(3, 4))).to.be.true;
+ });
+ })
+ });
+})
diff --git a/test/spec/unit/core/events_spec.js b/test/spec/unit/core/events_spec.js
new file mode 100644
index 00000000000..e1451f657b5
--- /dev/null
+++ b/test/spec/unit/core/events_spec.js
@@ -0,0 +1,45 @@
+import {config} from 'src/config.js';
+import {emit, clearEvents, getEvents, on, off} from '../../../../src/events.js';
+import * as utils from '../../../../src/utils.js'
+
+describe('events', () => {
+ let clock;
+ beforeEach(() => {
+ clock = sinon.useFakeTimers();
+ clearEvents();
+ });
+ afterEach(() => {
+ clock.restore();
+ });
+
+ it('should clear event log using eventHistoryTTL config', () => {
+ emit('testEvent', {});
+ expect(getEvents().length).to.eql(1);
+ config.setConfig({eventHistoryTTL: 1});
+ clock.tick(500);
+ expect(getEvents().length).to.eql(1);
+ clock.tick(6000);
+ expect(getEvents().length).to.eql(0);
+ });
+
+ it('should take history TTL in seconds', () => {
+ emit('testEvent', {});
+ config.setConfig({eventHistoryTTL: 1000});
+ clock.tick(10000);
+ expect(getEvents().length).to.eql(1);
+ });
+
+ it('should include the eventString if a callback fails', () => {
+ const logErrorStub = sinon.stub(utils, 'logError');
+ const eventString = 'bidWon';
+ let fn = function() { throw new Error('Test error'); };
+ on(eventString, fn);
+
+ emit(eventString, {});
+
+ sinon.assert.calledWith(logErrorStub, 'Error executing handler:', 'events.js', sinon.match.instanceOf(Error), eventString);
+
+ off(eventString, fn);
+ logErrorStub.restore();
+ });
+})
diff --git a/test/spec/unit/core/targeting_spec.js b/test/spec/unit/core/targeting_spec.js
index f16d6208087..ba9aeff70d1 100644
--- a/test/spec/unit/core/targeting_spec.js
+++ b/test/spec/unit/core/targeting_spec.js
@@ -1,13 +1,19 @@
-import { expect } from 'chai';
-import { targeting as targetingInstance, filters, getHighestCpmBidsFromBidPool, sortByDealAndPriceBucketOrCpm } from 'src/targeting.js';
-import { config } from 'src/config.js';
-import { createBidReceived } from 'test/fixtures/fixtures.js';
+import {expect} from 'chai';
+import {
+ filters,
+ getHighestCpmBidsFromBidPool,
+ sortByDealAndPriceBucketOrCpm,
+ targeting as targetingInstance
+} from 'src/targeting.js';
+import {config} from 'src/config.js';
+import {createBidReceived} from 'test/fixtures/fixtures.js';
import CONSTANTS from 'src/constants.json';
-import { auctionManager } from 'src/auctionManager.js';
+import {auctionManager} from 'src/auctionManager.js';
import * as utils from 'src/utils.js';
import {deepClone} from 'src/utils.js';
import {createBid} from '../../../../src/bidfactory.js';
import {hook} from '../../../../src/hook.js';
+import {getHighestCpm} from '../../../../src/utils/reducers.js';
function mkBid(bid, status = CONSTANTS.STATUS.GOOD) {
return Object.assign(createBid(status), bid);
@@ -451,7 +457,7 @@ describe('targeting tests', function () {
}
});
- const bids = getHighestCpmBidsFromBidPool(bidsReceived, utils.getHighestCpm, 2);
+ const bids = getHighestCpmBidsFromBidPool(bidsReceived, getHighestCpm, 2);
expect(bids.length).to.equal(3);
expect(bids[0].adId).to.equal('8383838');
@@ -467,7 +473,7 @@ describe('targeting tests', function () {
}
});
- const bids = getHighestCpmBidsFromBidPool(bidsReceived, utils.getHighestCpm, 2);
+ const bids = getHighestCpmBidsFromBidPool(bidsReceived, getHighestCpm, 2);
expect(bids.length).to.equal(3);
expect(bids[0].adId).to.equal('8383838');
@@ -949,6 +955,7 @@ describe('targeting tests', function () {
expect(bids.length).to.equal(1);
expect(bids[0].adId).to.equal('adid-1');
+ expect(bids[0].latestTargetedAuctionId).to.equal(2);
useBidCache = false;
@@ -956,6 +963,7 @@ describe('targeting tests', function () {
expect(bids.length).to.equal(1);
expect(bids[0].adId).to.equal('adid-2');
+ expect(bids[0].latestTargetedAuctionId).to.equal(2);
});
it('should use bidCacheFilterFunction', function() {
@@ -983,9 +991,13 @@ describe('targeting tests', function () {
expect(bids.length).to.equal(4);
expect(bids[0].adId).to.equal('adid-1');
+ expect(bids[0].latestTargetedAuctionId).to.equal(2);
expect(bids[1].adId).to.equal('adid-4');
+ expect(bids[1].latestTargetedAuctionId).to.equal(2);
expect(bids[2].adId).to.equal('adid-5');
+ expect(bids[2].latestTargetedAuctionId).to.equal(2);
expect(bids[3].adId).to.equal('adid-8');
+ expect(bids[3].latestTargetedAuctionId).to.equal(2);
// Bid Caching Off, No Filter Function
useBidCache = false;
@@ -994,9 +1006,13 @@ describe('targeting tests', function () {
expect(bids.length).to.equal(4);
expect(bids[0].adId).to.equal('adid-2');
+ expect(bids[0].latestTargetedAuctionId).to.equal(2);
expect(bids[1].adId).to.equal('adid-4');
+ expect(bids[1].latestTargetedAuctionId).to.equal(2);
expect(bids[2].adId).to.equal('adid-6');
+ expect(bids[2].latestTargetedAuctionId).to.equal(2);
expect(bids[3].adId).to.equal('adid-8');
+ expect(bids[3].latestTargetedAuctionId).to.equal(2);
// Bid Caching On AGAIN, No Filter Function (should be same as first time)
useBidCache = true;
@@ -1005,9 +1021,13 @@ describe('targeting tests', function () {
expect(bids.length).to.equal(4);
expect(bids[0].adId).to.equal('adid-1');
+ expect(bids[0].latestTargetedAuctionId).to.equal(2);
expect(bids[1].adId).to.equal('adid-4');
+ expect(bids[1].latestTargetedAuctionId).to.equal(2);
expect(bids[2].adId).to.equal('adid-5');
+ expect(bids[2].latestTargetedAuctionId).to.equal(2);
expect(bids[3].adId).to.equal('adid-8');
+ expect(bids[3].latestTargetedAuctionId).to.equal(2);
// Bid Caching On, with Filter Function to Exclude video
useBidCache = true;
@@ -1020,9 +1040,13 @@ describe('targeting tests', function () {
expect(bids.length).to.equal(4);
expect(bids[0].adId).to.equal('adid-1');
+ expect(bids[0].latestTargetedAuctionId).to.equal(2);
expect(bids[1].adId).to.equal('adid-4');
+ expect(bids[1].latestTargetedAuctionId).to.equal(2);
expect(bids[2].adId).to.equal('adid-6');
+ expect(bids[2].latestTargetedAuctionId).to.equal(2);
expect(bids[3].adId).to.equal('adid-8');
+ expect(bids[3].latestTargetedAuctionId).to.equal(2);
// filter function should have been called for each cached bid (4 times)
expect(bcffCalled).to.equal(4);
@@ -1038,9 +1062,13 @@ describe('targeting tests', function () {
expect(bids.length).to.equal(4);
expect(bids[0].adId).to.equal('adid-2');
+ expect(bids[0].latestTargetedAuctionId).to.equal(2);
expect(bids[1].adId).to.equal('adid-4');
+ expect(bids[1].latestTargetedAuctionId).to.equal(2);
expect(bids[2].adId).to.equal('adid-6');
+ expect(bids[2].latestTargetedAuctionId).to.equal(2);
expect(bids[3].adId).to.equal('adid-8');
+ expect(bids[3].latestTargetedAuctionId).to.equal(2);
// filter function should not have been called
expect(bcffCalled).to.equal(0);
});
diff --git a/test/spec/unit/pbjs_api_spec.js b/test/spec/unit/pbjs_api_spec.js
index 5c361d186c0..39123d4aa41 100644
--- a/test/spec/unit/pbjs_api_spec.js
+++ b/test/spec/unit/pbjs_api_spec.js
@@ -14,7 +14,7 @@ import { config as configObj } from 'src/config.js';
import * as ajaxLib from 'src/ajax.js';
import * as auctionModule from 'src/auction.js';
import { registerBidder } from 'src/adapters/bidderFactory.js';
-import { _sendAdToCreative } from 'src/secureCreatives.js';
+import {resizeRemoteCreative} from 'src/secureCreatives.js';
import {find} from 'src/polyfill.js';
import * as pbjsModule from 'src/prebid.js';
import {hook} from '../../../src/hook.js';
@@ -25,7 +25,7 @@ import {stubAuctionIndex} from '../../helpers/indexStub.js';
import {createBid} from '../../../src/bidfactory.js';
import {enrichFPD} from '../../../src/fpd/enrichment.js';
import {mockFpdEnrichments} from '../../helpers/fpd.js';
-
+import {generateUUID} from '../../../src/utils.js';
var assert = require('chai').assert;
var expect = require('chai').expect;
@@ -43,13 +43,13 @@ var adUnits = getAdUnits();
var adUnitCodes = getAdUnits().map(unit => unit.code);
var bidsBackHandler = function() {};
const timeout = 2000;
-var auction = auctionManager.createAuction({adUnits, adUnitCodes, callback: bidsBackHandler, cbTimeout: timeout});
-auction.getBidRequests = getBidRequests;
-auction.getBidsReceived = getBidResponses;
-auction.getAdUnits = getAdUnits;
-auction.getAuctionStatus = function() { return auctionModule.AUCTION_COMPLETED }
+const auctionId = generateUUID();
+let auction;
function resetAuction() {
+ if (auction == null) {
+ auction = auctionManager.createAuction({adUnits, adUnitCodes, callback: bidsBackHandler, cbTimeout: timeout, labels: undefined, auctionId: auctionId});
+ }
$$PREBID_GLOBAL$$.setConfig({ enableSendAllBids: false });
auction.getBidRequests = getBidRequests;
auction.getBidsReceived = getBidResponses;
@@ -1104,7 +1104,7 @@ describe('Unit: Prebid Module', function () {
adUnitCode: config.adUnitCodes[0],
};
- _sendAdToCreative(mockAdObject, sinon.stub());
+ resizeRemoteCreative(mockAdObject);
expect(slots[0].spyGetSlotElementId.called).to.equal(false);
expect(slots[1].spyGetSlotElementId.called).to.equal(true);
@@ -1233,7 +1233,8 @@ describe('Unit: Prebid Module', function () {
}
},
getElementsByTagName: sinon.stub(),
- querySelector: sinon.stub()
+ querySelector: sinon.stub(),
+ createElement: sinon.stub(),
};
elStub = {
@@ -1264,7 +1265,7 @@ describe('Unit: Prebid Module', function () {
it('should require doc and id params', function () {
$$PREBID_GLOBAL$$.renderAd();
- var error = 'Error trying to write ad Id :undefined to the page. Missing adId';
+ var error = 'Error rendering ad (id: undefined): missing adId';
assert.ok(spyLogError.calledWith(error), 'expected param error was logged');
});
@@ -1289,14 +1290,13 @@ describe('Unit: Prebid Module', function () {
adUrl: 'http://server.example.com/ad/ad.js'
});
$$PREBID_GLOBAL$$.renderAd(doc, bidId);
- assert.ok(elStub.insertBefore.called, 'url was written to iframe in doc');
+ sinon.assert.calledWith(doc.createElement, 'iframe');
});
it('should log an error when no ad or url', function () {
pushBidResponseToAuction({});
$$PREBID_GLOBAL$$.renderAd(doc, bidId);
- var error = 'Error trying to write ad. No ad for bid response id: ' + bidId;
- assert.ok(spyLogError.calledWith(error), 'expected error was logged');
+ sinon.assert.called(spyLogError);
});
it('should log an error when not in an iFrame', function () {
@@ -1305,7 +1305,7 @@ describe('Unit: Prebid Module', function () {
});
inIframe = false;
$$PREBID_GLOBAL$$.renderAd(document, bidId);
- const error = 'Error trying to write ad. Ad render call ad id ' + bidId + ' was prevented from writing to the main document.';
+ const error = `Error rendering ad (id: ${bidId}): renderAd was prevented from writing to the main document.`;
assert.ok(spyLogError.calledWith(error), 'expected error was logged');
});
@@ -1326,14 +1326,14 @@ describe('Unit: Prebid Module', function () {
doc.write = sinon.stub().throws(error);
$$PREBID_GLOBAL$$.renderAd(doc, bidId);
- var errorMessage = 'Error trying to write ad Id :' + bidId + ' to the page:' + error.message;
+ var errorMessage = `Error rendering ad (id: ${bidId}): doc write error`
assert.ok(spyLogError.calledWith(errorMessage), 'expected error was logged');
});
it('should log an error when ad not found', function () {
var fakeId = 99;
$$PREBID_GLOBAL$$.renderAd(doc, fakeId);
- var error = 'Error trying to write ad. Cannot find ad by given id : ' + fakeId;
+ var error = `Error rendering ad (id: ${fakeId}): Cannot find ad '${fakeId}'`
assert.ok(spyLogError.calledWith(error), 'expected error was logged');
});
@@ -1345,14 +1345,6 @@ 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({
@@ -2736,6 +2728,13 @@ describe('Unit: Prebid Module', function () {
events.on.restore();
});
+ it('should emit event BID_ACCEPTED when invoked', function () {
+ var callback = sinon.spy();
+ $$PREBID_GLOBAL$$.onEvent('bidAccepted', callback);
+ events.emit(CONSTANTS.EVENTS.BID_ACCEPTED);
+ sinon.assert.calledOnce(callback);
+ });
+
describe('beforeRequestBids', function () {
let bidRequestedHandler;
let beforeRequestBidsHandler;
@@ -3304,16 +3303,20 @@ describe('Unit: Prebid Module', function () {
const highestBid = $$PREBID_GLOBAL$$.getHighestUnusedBidResponseForAdUnitCode('/19968336/header-bid-tag-0');
expect(highestBid).to.deep.equal(_bidsReceived[2])
})
- })
+ });
- describe('getHighestCpm', () => {
+ describe('getHighestCpmBids', () => {
after(() => {
resetAuction();
});
it('returns an array containing the highest bid object for the given adUnitCode', function () {
- const highestCpmBids = $$PREBID_GLOBAL$$.getHighestCpmBids('/19968336/header-bid-tag-0');
+ const adUnitcode = '/19968336/header-bid-tag-0';
+ targeting.setLatestAuctionForAdUnit(adUnitcode, auctionId)
+ const highestCpmBids = $$PREBID_GLOBAL$$.getHighestCpmBids(adUnitcode);
expect(highestCpmBids.length).to.equal(1);
- expect(highestCpmBids[0]).to.deep.equal(auctionManager.getBidsReceived()[1]);
+ const expectedBid = auctionManager.getBidsReceived()[1];
+ expectedBid.latestTargetedAuctionId = auctionId;
+ expect(highestCpmBids[0]).to.deep.equal(expectedBid);
});
it('returns an empty array when the given adUnit is not found', function () {
diff --git a/test/spec/unit/secureCreatives_spec.js b/test/spec/unit/secureCreatives_spec.js
index 7d5f9af35dd..895bf03165a 100644
--- a/test/spec/unit/secureCreatives_spec.js
+++ b/test/spec/unit/secureCreatives_spec.js
@@ -1,6 +1,4 @@
-import {
- _sendAdToCreative, getReplier, receiveMessage
-} from 'src/secureCreatives.js';
+import {getReplier, receiveMessage} from 'src/secureCreatives.js';
import * as utils from 'src/utils.js';
import {getAdUnits, getBidRequests, getBidResponses} from 'test/fixtures/fixtures.js';
import {auctionManager} from 'src/auctionManager.js';
@@ -8,10 +6,11 @@ import * as auctionModule from 'src/auction.js';
import * as native from 'src/native.js';
import {fireNativeTrackers, getAllAssetsMessage} from 'src/native.js';
import * as events from 'src/events.js';
-import { config as configObj } from 'src/config.js';
+import {config as configObj} from 'src/config.js';
import 'src/prebid.js';
-import { expect } from 'chai';
+import {expect} from 'chai';
+import {handleRender} from '../../../src/adRendering.js';
var CONSTANTS = require('src/constants.json');
@@ -54,37 +53,45 @@ describe('secureCreatives', () => {
});
});
- describe('_sendAdToCreative', () => {
- beforeEach(function () {
- sinon.stub(utils, 'logError');
- sinon.stub(utils, 'logWarn');
+ describe('handleRender', () => {
+ let bidResponse, renderFn, result;
+ beforeEach(() => {
+ result = null;
+ renderFn = sinon.stub().callsFake((r) => { result = r; });
+ bidResponse = {
+ adId: 123
+ }
});
- afterEach(function () {
- utils.logError.restore();
- utils.logWarn.restore();
+ it('does not invoke renderFn, but the renderer instead, if the ad has one', () => {
+ const renderer = {
+ url: 'some-custom-renderer',
+ render: sinon.spy()
+ }
+ handleRender(renderFn, {bidResponse: {renderer}});
+ sinon.assert.notCalled(renderFn);
+ sinon.assert.called(renderer.render);
});
- it('should macro replace ${AUCTION_PRICE} with the winning bid for ad and adUrl', () => {
- const oldVal = window.googletag;
- const oldapntag = window.apntag;
- window.apntag = null
- window.googletag = null;
- const mockAdObject = {
- adId: 'someAdId',
- ad: '',
- adUrl: 'http://creative.prebid.org/${AUCTION_PRICE}',
- width: 300,
- height: 250,
- renderer: null,
- cpm: '1.00',
- adUnitCode: 'some_dom_id'
- };
- const reply = sinon.spy();
- _sendAdToCreative(mockAdObject, reply);
- expect(reply.args[0][0].ad).to.equal('');
- expect(reply.args[0][0].adUrl).to.equal('http://creative.prebid.org/1.00');
- window.googletag = oldVal;
- window.apntag = oldapntag;
+
+ ['ad', 'adUrl'].forEach((prop) => {
+ describe(`on ${prop}`, () => {
+ it('replaces AUCTION_PRICE macro', () => {
+ bidResponse[prop] = 'pre${AUCTION_PRICE}post';
+ bidResponse.cpm = 123;
+ handleRender(renderFn, {adId: 123, bidResponse});
+ expect(result[prop]).to.eql('pre123post');
+ });
+ it('replaces CLICKTHROUGH macro', () => {
+ bidResponse[prop] = 'pre${CLICKTHROUGH}post';
+ handleRender(renderFn, {adId: 123, bidResponse, options: {clickUrl: 'clk'}});
+ expect(result[prop]).to.eql('preclkpost');
+ });
+ it('defaults CLICKTHROUGH to empty string', () => {
+ bidResponse[prop] = 'pre${CLICKTHROUGH}post';
+ handleRender(renderFn, {adId: 123, bidResponse});
+ expect(result[prop]).to.eql('prepost');
+ });
+ });
});
});
diff --git a/test/spec/unit/utils/reducers_spec.js b/test/spec/unit/utils/reducers_spec.js
new file mode 100644
index 00000000000..95bf3b74041
--- /dev/null
+++ b/test/spec/unit/utils/reducers_spec.js
@@ -0,0 +1,124 @@
+import {
+ tiebreakCompare,
+ keyCompare,
+ simpleCompare,
+ minimum,
+ maximum,
+ getHighestCpm,
+ getOldestHighestCpmBid, getLatestHighestCpmBid, reverseCompare
+} from '../../../../src/utils/reducers.js';
+import assert from 'assert';
+
+describe('reducers', () => {
+ describe('simpleCompare', () => {
+ Object.entries({
+ '<': [10, 20, -1],
+ '===': [123, 123, 0],
+ '>': [30, -10, 1]
+ }).forEach(([t, [a, b, expected]]) => {
+ it(`returns ${expected} when a ${t} b`, () => {
+ expect(simpleCompare(a, b)).to.equal(expected);
+ })
+ })
+ });
+
+ describe('keyCompare', () => {
+ Object.entries({
+ '<': [{k: -123}, {k: 0}, -1],
+ '===': [{k: 0}, {k: 0}, 0],
+ '>': [{k: 2}, {k: 1}, 1]
+ }).forEach(([t, [a, b, expected]]) => {
+ it(`returns ${expected} when key(a) ${t} key(b)`, () => {
+ expect(keyCompare(item => item.k)(a, b)).to.equal(expected);
+ })
+ })
+ });
+
+ describe('tiebreakCompare', () => {
+ Object.entries({
+ 'first compare says a < b': [{main: 1, tie: 2}, {main: 2, tie: 1}, -1],
+ 'first compare says a > b': [{main: 2, tie: 1}, {main: 1, tie: 2}, 1],
+ 'first compare ties, second says a < b': [{main: 0, tie: 1}, {main: 0, tie: 2}, -1],
+ 'first compare ties, second says a > b': [{main: 0, tie: 2}, {main: 0, tie: 1}, 1],
+ 'all compares tie': [{main: 0, tie: 0}, {main: 0, tie: 0}, 0]
+ }).forEach(([t, [a, b, expected]]) => {
+ it(`should return ${expected} when ${t}`, () => {
+ const cmp = tiebreakCompare(keyCompare(item => item.main), keyCompare(item => item.tie));
+ expect(cmp(a, b)).to.equal(expected);
+ })
+ })
+ });
+
+ const SAMPLE_ARR = [-10, 20, 20, 123, 400];
+
+ Object.entries({
+ 'minimum': [minimum, ['minimum', -10], ['maximum', 400]],
+ 'maximum': [maximum, ['maximum', 400], ['minimum', -10]]
+ }).forEach(([t, [fn, simple, reversed]]) => {
+ describe(t, () => {
+ it(`should find ${simple[0]} using simple compare`, () => {
+ expect(SAMPLE_ARR.reduce(fn(simpleCompare))).to.equal(simple[1]);
+ });
+ it(`should find ${reversed[0]} using reverse compare`, () => {
+ expect(SAMPLE_ARR.reduce(fn(reverseCompare()))).to.equal(reversed[1]);
+ });
+ })
+ });
+
+ describe('getHighestCpm', function () {
+ it('should pick the highest cpm', function () {
+ let a = {
+ cpm: 2,
+ timeToRespond: 100
+ };
+ let b = {
+ cpm: 1,
+ timeToRespond: 100
+ };
+ expect(getHighestCpm(a, b)).to.eql(a);
+ expect(getHighestCpm(b, a)).to.eql(a);
+ });
+
+ it('should pick the lowest timeToRespond cpm in case of tie', function () {
+ let a = {
+ cpm: 1,
+ timeToRespond: 100
+ };
+ let b = {
+ cpm: 1,
+ timeToRespond: 50
+ };
+ expect(getHighestCpm(a, b)).to.eql(b);
+ expect(getHighestCpm(b, a)).to.eql(b);
+ });
+ });
+
+ describe('getOldestHighestCpmBid', () => {
+ it('should pick the oldest in case of tie using responseTimeStamp', function () {
+ let a = {
+ cpm: 1,
+ responseTimestamp: 1000
+ };
+ let b = {
+ cpm: 1,
+ responseTimestamp: 2000
+ };
+ expect(getOldestHighestCpmBid(a, b)).to.eql(a);
+ expect(getOldestHighestCpmBid(b, a)).to.eql(a);
+ });
+ });
+ describe('getLatestHighestCpmBid', () => {
+ it('should pick the latest in case of tie using responseTimeStamp', function () {
+ let a = {
+ cpm: 1,
+ responseTimestamp: 1000
+ };
+ let b = {
+ cpm: 1,
+ responseTimestamp: 2000
+ };
+ expect(getLatestHighestCpmBid(a, b)).to.eql(b);
+ expect(getLatestHighestCpmBid(b, a)).to.eql(b);
+ });
+ });
+})
diff --git a/test/spec/unit/utils/ttlCollection_spec.js b/test/spec/unit/utils/ttlCollection_spec.js
new file mode 100644
index 00000000000..29c6c438855
--- /dev/null
+++ b/test/spec/unit/utils/ttlCollection_spec.js
@@ -0,0 +1,180 @@
+import {ttlCollection} from '../../../../src/utils/ttlCollection.js';
+
+describe('ttlCollection', () => {
+ it('can add & retrieve items', () => {
+ const coll = ttlCollection();
+ expect(coll.toArray()).to.eql([]);
+ coll.add(1);
+ coll.add(2);
+ expect(coll.toArray()).to.eql([1, 2]);
+ });
+
+ it('can clear', () => {
+ const coll = ttlCollection();
+ coll.add('item');
+ coll.clear();
+ expect(coll.toArray()).to.eql([]);
+ });
+
+ it('can be iterated over', () => {
+ const coll = ttlCollection();
+ coll.add('1');
+ coll.add('2');
+ expect(Array.from(coll)).to.eql(['1', '2']);
+ })
+
+ describe('autopurge', () => {
+ let clock, pms, waitForPromises;
+ const SLACK = 2000;
+ beforeEach(() => {
+ clock = sinon.useFakeTimers();
+ pms = [];
+ waitForPromises = () => Promise.all(pms);
+ });
+ afterEach(() => {
+ clock.restore();
+ });
+
+ Object.entries({
+ 'defer': (value) => {
+ const pm = Promise.resolve(value);
+ pms.push(pm);
+ return pm;
+ },
+ 'do not defer': (value) => value,
+ }).forEach(([t, resolve]) => {
+ describe(`when ttl/startTime ${t}`, () => {
+ let coll;
+ beforeEach(() => {
+ coll = ttlCollection({
+ startTime: (item) => resolve(item.start == null ? new Date().getTime() : item.start),
+ ttl: (item) => resolve(item.ttl),
+ slack: SLACK
+ })
+ });
+
+ it('should clear items after enough time has passed', () => {
+ coll.add({no: 'ttl'});
+ coll.add({ttl: 1000});
+ coll.add({ttl: 4000});
+ return waitForPromises().then(() => {
+ clock.tick(500);
+ expect(coll.toArray()).to.eql([{no: 'ttl'}, {ttl: 1000}, {ttl: 4000}]);
+ clock.tick(SLACK + 500);
+ expect(coll.toArray()).to.eql([{no: 'ttl'}, {ttl: 4000}]);
+ clock.tick(3000);
+ expect(coll.toArray()).to.eql([{no: 'ttl'}]);
+ });
+ });
+
+ it('should not wait too long if a shorter ttl shows up', () => {
+ coll.add({ttl: 4000});
+ coll.add({ttl: 1000});
+ return waitForPromises().then(() => {
+ clock.tick(1000 + SLACK);
+ expect(coll.toArray()).to.eql([
+ {ttl: 4000}
+ ]);
+ });
+ });
+
+ it('should not wait more if later ttls are within slack', () => {
+ coll.add({start: 0, ttl: 4000});
+ return waitForPromises().then(() => {
+ clock.tick(4000);
+ coll.add({start: 0, ttl: 5000});
+ return waitForPromises().then(() => {
+ clock.tick(SLACK);
+ expect(coll.toArray()).to.eql([]);
+ });
+ });
+ });
+
+ it('should clear items ASAP if they expire in the past', () => {
+ clock.tick(10000);
+ coll.add({start: 0, ttl: 1000});
+ return waitForPromises().then(() => {
+ clock.tick(SLACK);
+ expect(coll.toArray()).to.eql([]);
+ });
+ });
+
+ it('should clear items ASAP if they have ttl = 0', () => {
+ coll.add({ttl: 0});
+ return waitForPromises().then(() => {
+ clock.tick(SLACK);
+ expect(coll.toArray()).to.eql([]);
+ });
+ });
+
+ describe('refresh', () => {
+ it('should refresh missing TTLs', () => {
+ const item = {};
+ coll.add(item);
+ return waitForPromises().then(() => {
+ item.ttl = 1000;
+ return waitForPromises().then(() => {
+ clock.tick(1000 + SLACK);
+ expect(coll.toArray()).to.eql([item]);
+ coll.refresh();
+ return waitForPromises().then(() => {
+ clock.tick(1);
+ expect(coll.toArray()).to.eql([]);
+ });
+ });
+ });
+ });
+
+ it('should refresh existing TTLs', () => {
+ const item = {
+ ttl: 1000
+ };
+ coll.add(item);
+ return waitForPromises().then(() => {
+ clock.tick(1000);
+ item.ttl = 4000;
+ coll.refresh();
+ return waitForPromises().then(() => {
+ clock.tick(SLACK);
+ expect(coll.toArray()).to.eql([item]);
+ clock.tick(3000);
+ expect(coll.toArray()).to.eql([]);
+ });
+ });
+ });
+
+ it('should discard initial TTL if it does not resolve before a refresh', () => {
+ let resolveTTL;
+ const item = {
+ ttl: new Promise((resolve) => {
+ resolveTTL = resolve;
+ })
+ };
+ coll.add(item);
+ item.ttl = null;
+ coll.refresh();
+ resolveTTL(1000);
+ return waitForPromises().then(() => {
+ clock.tick(1000 + SLACK + 1000);
+ expect(coll.toArray()).to.eql([item]);
+ });
+ });
+
+ it('should discard TTLs on clear', () => {
+ const item = {
+ ttl: 1000
+ };
+ coll.add(item);
+ coll.clear();
+ item.ttl = null;
+ coll.add(item);
+ return waitForPromises().then(() => {
+ clock.tick(1000 + SLACK + 1000);
+ expect(coll.toArray()).to.eql([item]);
+ });
+ });
+ });
+ });
+ });
+ });
+});
diff --git a/test/spec/utils_spec.js b/test/spec/utils_spec.js
index e26683074c8..098582c0af6 100644
--- a/test/spec/utils_spec.js
+++ b/test/spec/utils_spec.js
@@ -2,7 +2,9 @@ import {getAdServerTargeting} from 'test/fixtures/fixtures.js';
import {expect} from 'chai';
import CONSTANTS from 'src/constants.json';
import * as utils from 'src/utils.js';
-import {deepEqual, memoize, waitForElementToLoad} from 'src/utils.js';
+import {getHighestCpm, getLatestHighestCpmBid, getOldestHighestCpmBid} from '../../src/utils/reducers.js';
+import {binarySearch, deepEqual, memoize, waitForElementToLoad} from 'src/utils.js';
+import {convertCamelToUnderscore} from '../../libraries/appnexusUtils/anUtils.js';
var assert = require('assert');
@@ -39,28 +41,6 @@ describe('Utils', function () {
});
});
- describe('tryAppendQueryString', function () {
- it('should append query string to existing url', function () {
- var url = 'www.a.com?';
- var key = 'b';
- var value = 'c';
-
- var output = utils.tryAppendQueryString(url, key, value);
-
- var expectedResult = url + key + '=' + encodeURIComponent(value) + '&';
- assert.equal(output, expectedResult);
- });
-
- it('should return existing url, if the value is empty', function () {
- var url = 'www.a.com?';
- var key = 'b';
- var value = '';
-
- var output = utils.tryAppendQueryString(url, key, value);
- assert.equal(output, url);
- });
- });
-
describe('parseQueryStringParameters', function () {
it('should append query string to existing using the input obj', function () {
var obj = {
@@ -538,72 +518,6 @@ describe('Utils', function () {
});
});
- describe('getHighestCpm', function () {
- it('should pick the existing highest cpm', function () {
- let previous = {
- cpm: 2,
- timeToRespond: 100
- };
- let current = {
- cpm: 1,
- timeToRespond: 100
- };
- assert.equal(utils.getHighestCpm(previous, current), previous);
- });
-
- it('should pick the new highest cpm', function () {
- let previous = {
- cpm: 1,
- timeToRespond: 100
- };
- let current = {
- cpm: 2,
- timeToRespond: 100
- };
- assert.equal(utils.getHighestCpm(previous, current), current);
- });
-
- it('should pick the fastest cpm in case of tie', function () {
- let previous = {
- cpm: 1,
- timeToRespond: 100
- };
- let current = {
- cpm: 1,
- timeToRespond: 50
- };
- assert.equal(utils.getHighestCpm(previous, current), current);
- });
-
- it('should pick the oldest in case of tie using responseTimeStamp', function () {
- let previous = {
- cpm: 1,
- timeToRespond: 100,
- responseTimestamp: 1000
- };
- let current = {
- cpm: 1,
- timeToRespond: 50,
- responseTimestamp: 2000
- };
- assert.equal(utils.getOldestHighestCpmBid(previous, current), previous);
- });
-
- it('should pick the latest in case of tie using responseTimeStamp', function () {
- let previous = {
- cpm: 1,
- timeToRespond: 100,
- responseTimestamp: 1000
- };
- let current = {
- cpm: 1,
- timeToRespond: 50,
- responseTimestamp: 2000
- };
- assert.equal(utils.getLatestHighestCpmBid(previous, current), current);
- });
- });
-
describe('polyfill test', function () {
it('should not add polyfill to array', function() {
var arr = ['hello', 'world'];
@@ -765,43 +679,15 @@ describe('Utils', function () {
describe('convertCamelToUnderscore', function () {
it('returns converted string value using underscore syntax instead of camelCase', function () {
let var1 = 'placementIdTest';
- let test1 = utils.convertCamelToUnderscore(var1);
+ let test1 = convertCamelToUnderscore(var1);
expect(test1).to.equal('placement_id_test');
let var2 = 'my_test_value';
- let test2 = utils.convertCamelToUnderscore(var2);
+ let test2 = convertCamelToUnderscore(var2);
expect(test2).to.equal(var2);
});
});
- describe('getAdUnitSizes', function () {
- it('returns an empty response when adUnits is undefined', function () {
- let sizes = utils.getAdUnitSizes();
- expect(sizes).to.be.undefined;
- });
-
- it('returns an empty array when invalid data is present in adUnit object', function () {
- let sizes = utils.getAdUnitSizes({ sizes: 300 });
- expect(sizes).to.deep.equal([]);
- });
-
- it('retuns an array of arrays when reading from adUnit.sizes', function () {
- let sizes = utils.getAdUnitSizes({ sizes: [300, 250] });
- expect(sizes).to.deep.equal([[300, 250]]);
-
- sizes = utils.getAdUnitSizes({ sizes: [[300, 250], [300, 600]] });
- expect(sizes).to.deep.equal([[300, 250], [300, 600]]);
- });
-
- it('returns an array of arrays when reading from adUnit.mediaTypes.banner.sizes', function () {
- let sizes = utils.getAdUnitSizes({ mediaTypes: { banner: { sizes: [300, 250] } } });
- expect(sizes).to.deep.equal([[300, 250]]);
-
- sizes = utils.getAdUnitSizes({ mediaTypes: { banner: { sizes: [[300, 250], [300, 600]] } } });
- expect(sizes).to.deep.equal([[300, 250], [300, 600]]);
- });
- });
-
describe('URL helpers', function () {
describe('parseUrl()', function () {
let parsed;
@@ -1233,5 +1119,44 @@ describe('memoize', () => {
mem('one', 'three');
expect(mem('one', 'three')).to.eql(['one', 'three']);
expect(fn.callCount).to.eql(2);
- })
+ });
+
+ describe('binarySearch', () => {
+ [
+ {
+ arr: [],
+ tests: [
+ ['any', 0]
+ ]
+ },
+ {
+ arr: [10],
+ tests: [
+ [5, 0],
+ [10, 0],
+ [20, 1],
+ ],
+ },
+ {
+ arr: [10, 20, 30, 30, 40],
+ tests: [
+ [5, 0],
+ [15, 1],
+ [10, 0],
+ [30, 2],
+ [35, 4],
+ [40, 4],
+ [100, 5]
+ ]
+ }
+ ].forEach(({arr, tests}) => {
+ describe(`on ${arr}`, () => {
+ tests.forEach(([el, pos]) => {
+ it(`finds index for ${el} => ${pos}`, () => {
+ expect(binarySearch(arr, el)).to.equal(pos);
+ });
+ });
+ });
+ })
+ });
})
diff --git a/test/spec/video_spec.js b/test/spec/video_spec.js
index 61621c7ec42..35d0a4fef24 100644
--- a/test/spec/video_spec.js
+++ b/test/spec/video_spec.js
@@ -1,4 +1,4 @@
-import { isValidVideoBid } from 'src/video.js';
+import {fillVideoDefaults, isValidVideoBid} from 'src/video.js';
import {hook} from '../../src/hook.js';
import {stubAuctionIndex} from '../helpers/indexStub.js';
@@ -7,97 +7,169 @@ describe('video.js', function () {
hook.ready();
});
- it('validates valid instream bids', function () {
- const bid = {
- adId: '456xyz',
- vastUrl: 'http://www.example.com/vastUrl',
- transactionId: 'au'
- };
- const adUnits = [{
- transactionId: 'au',
- mediaTypes: {
- video: {context: 'instream'}
- }
- }];
- const valid = isValidVideoBid(bid, {index: stubAuctionIndex({adUnits})});
- expect(valid).to.equal(true);
- });
+ describe('fillVideoDefaults', () => {
+ function fillDefaults(videoMediaType = {}) {
+ const adUnit = {mediaTypes: {video: videoMediaType}};
+ fillVideoDefaults(adUnit);
+ return adUnit.mediaTypes.video;
+ }
- it('catches invalid instream bids', function () {
- const bid = {
- transactionId: 'au'
- };
- const adUnits = [{
- transactionId: 'au',
- mediaTypes: {
- video: {context: 'instream'}
- }
- }];
- const valid = isValidVideoBid(bid, {index: stubAuctionIndex({adUnits})});
- expect(valid).to.equal(false);
- });
+ describe('should set plcmt = 4 when', () => {
+ it('context is "outstream"', () => {
+ expect(fillDefaults({context: 'outstream'})).to.eql({
+ context: 'outstream',
+ plcmt: 4
+ })
+ });
+ [2, 3, 4].forEach(placement => {
+ it(`placemement is "${placement}"`, () => {
+ expect(fillDefaults({placement})).to.eql({
+ placement,
+ plcmt: 4
+ });
+ })
+ });
+ });
+ describe('should set plcmt = 2 when', () => {
+ [2, 6].forEach(playbackmethod => {
+ it(`playbackmethod is "${playbackmethod}"`, () => {
+ expect(fillDefaults({playbackmethod})).to.eql({
+ playbackmethod,
+ plcmt: 2,
+ });
+ });
+ });
+ });
+ describe('should not set plcmt when', () => {
+ Object.entries({
+ 'it was set by pub (context=outstream)': {
+ expected: 1,
+ video: {
+ context: 'outstream',
+ plcmt: 1
+ }
+ },
+ 'it was set by pub (placement=2)': {
+ expected: 1,
+ video: {
+ placement: 2,
+ plcmt: 1
+ }
+ },
+ 'placement not in 2, 3, 4': {
+ expected: undefined,
+ video: {
+ placement: 1
+ }
+ },
+ 'it was set by pub (playbackmethod=2)': {
+ expected: 1,
+ video: {
+ plcmt: 1,
+ playbackmethod: 2
+ }
+ }
+ }).forEach(([t, {expected, video}]) => {
+ it(t, () => {
+ expect(fillDefaults(video).plcmt).to.eql(expected);
+ })
+ })
+ })
+ })
- it('catches invalid bids when prebid-cache is disabled', function () {
- const adUnits = [{
- transactionId: 'au',
- bidder: 'vastOnlyVideoBidder',
- mediaTypes: {video: {}},
- }];
+ describe('isValidVideoBid', () => {
+ it('validates valid instream bids', function () {
+ const bid = {
+ adId: '456xyz',
+ vastUrl: 'http://www.example.com/vastUrl',
+ transactionId: 'au'
+ };
+ const adUnits = [{
+ transactionId: 'au',
+ mediaTypes: {
+ video: {context: 'instream'}
+ }
+ }];
+ const valid = isValidVideoBid(bid, {index: stubAuctionIndex({adUnits})});
+ expect(valid).to.equal(true);
+ });
- const valid = isValidVideoBid({ transactionId: 'au', vastXml: '