Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

EMX Digital Adapter Bug Fix - Outstream Renderer #5161

Merged
merged 10 commits into from
Apr 29, 2020
Merged

EMX Digital Adapter Bug Fix - Outstream Renderer #5161

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
e7cb062
adding ccpa support for emx_digital adapter
Dec 9, 2019
5c0cfc1
emx_digital ccpa compliance: lint fix
Dec 10, 2019
4c0a008
Merge branch 'master' of https://github.com/prebid/Prebid.js
Dec 17, 2019
676b419
emx 3.0 compliance update
Dec 17, 2019
36524b3
Merge branch 'master' of https://github.com/prebid/Prebid.js
ncolletti Jan 29, 2020
ec9f12f
Merge remote-tracking branch 'upstream/master'
Apr 22, 2020
9d96181
fix outstream renderer issue, update test spec
Apr 22, 2020
7a5fad2
sync with upstream
Apr 23, 2020
de685c9
Merge branch 'bug/EI-34'
Apr 23, 2020
b2d22a3
refactor formatVideoResponse function to use core-js/find
Apr 29, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 10 additions & 6 deletions modules/emx_digitalBidAdapter.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,12 @@ import { registerBidder } from '../src/adapters/bidderFactory.js';
import { BANNER, VIDEO } from '../src/mediaTypes.js';
import { Renderer } from '../src/Renderer.js';
import includes from 'core-js/library/fn/array/includes.js';
import find from 'core-js/library/fn/array/find.js';

const BIDDER_CODE = 'emx_digital';
const ENDPOINT = 'hb.emxdgt.com';
const RENDERER_URL = 'https://js.brealtime.com/outstream/1.30.0/bundle.js';
const ADAPTER_VERSION = '1.5.0';
const ADAPTER_VERSION = '1.5.1';
const DEFAULT_CUR = 'USD';

export const emxAdapter = {
Expand Down Expand Up @@ -41,11 +42,14 @@ export const emxAdapter = {
},
formatVideoResponse: (bidResponse, emxBid, bidRequest) => {
bidResponse.vastXml = emxBid.adm;
if (bidRequest.bidRequest && bidRequest.bidRequest.mediaTypes && bidRequest.bidRequest.mediaTypes.video && bidRequest.bidRequest.mediaTypes.video.context === 'outstream') {
bidResponse.renderer = emxAdapter.createRenderer(bidResponse, {
id: emxBid.id,
url: RENDERER_URL
});
if (bidRequest.bidderRequest && bidRequest.bidderRequest.bids && bidRequest.bidderRequest.bids.length > 0) {
const matchingBid = find(bidRequest.bidderRequest.bids, bid => bidResponse.requestId && bid.bidId && bidResponse.requestId === bid.bidId && bid.mediaTypes && bid.mediaTypes.video && bid.mediaTypes.video.context === 'outstream');
if (matchingBid) {
bidResponse.renderer = emxAdapter.createRenderer(bidResponse, {
id: emxBid.id,
url: RENDERER_URL
});
}
}
return bidResponse;
},
Expand Down
95 changes: 80 additions & 15 deletions test/spec/modules/emx_digitalBidAdapter_spec.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -335,30 +335,34 @@ describe('emx_digital Adapter', function () {

it('should have the right gdpr info when enabled', function () {
let consentString = 'OIJSZsOAFsABAB8EMXZZZZZ+A==';
bidderRequest.gdprConsent = {
const gdprBidderRequest = utils.deepClone(bidderRequest);
gdprBidderRequest.gdprConsent = {
'consentString': consentString,
'gdprApplies': true
};
let request = spec.buildRequests(bidderRequest.bids, bidderRequest);
let request = spec.buildRequests(gdprBidderRequest.bids, gdprBidderRequest);

request = JSON.parse(request.data)
expect(request.regs.ext).to.have.property('gdpr', 1);
expect(request.user.ext).to.have.property('consent', consentString);
});

it('should\'t contain consent string if gdpr isn\'t applied', function () {
bidderRequest.gdprConsent = {
const nonGdprBidderRequest = utils.deepClone(bidderRequest);
nonGdprBidderRequest.gdprConsent = {
'gdprApplies': false
};
let request = spec.buildRequests(bidderRequest.bids, bidderRequest);
let request = spec.buildRequests(nonGdprBidderRequest.bids, nonGdprBidderRequest);
request = JSON.parse(request.data)
expect(request.regs.ext).to.have.property('gdpr', 0);
expect(request).to.not.have.property('user');
});

it('should add us privacy info to request', function() {
const uspBidderRequest = utils.deepClone(bidderRequest);
let consentString = '1YNN';
bidderRequest.uspConsent = consentString;
let request = spec.buildRequests(bidderRequest.bids, bidderRequest);
uspBidderRequest.uspConsent = consentString;
let request = spec.buildRequests(uspBidderRequest.bids, uspBidderRequest);
request = JSON.parse(request.data);
expect(request.us_privacy).to.exist;
expect(request.us_privacy).to.exist.and.to.equal(consentString);
Expand Down Expand Up @@ -388,6 +392,52 @@ describe('emx_digital Adapter', function () {
'auctionId': '1d1a01234a475'
};

const bid_outstream = {
'bidderRequest': {
'bids': [{
'bidder': 'emx_digital',
'params': {
'tagid': '25251',
'video': {}
},
'mediaTypes': {
'video': {
'context': 'outstream',
'playerSize': [640, 480]
}
},
'adUnitCode': 'adunit-code',
'sizes': [
[300, 250],
[300, 600]
],
'bidId': '987654321cba',
'bidderRequestId': '22edbae3120bf6',
'auctionId': '1d1a01234a475'
}, {
'bidder': 'emx_digital',
'params': {
'tagid': '25252',
'video': {}
},
'mediaTypes': {
'video': {
'context': 'instream',
'playerSize': [640, 480]
}
},
'adUnitCode': 'adunit-code',
'sizes': [
[300, 250],
[300, 600]
],
'bidId': '987654321dcb',
'bidderRequestId': '22edbae3120bf6',
'auctionId': '1d1a01234a475'
}]
}
};

const serverResponse = {
'id': '12819a18-56e1-4256-b836-b69a10202668',
'seatbid': [{
Expand All @@ -408,7 +458,7 @@ describe('emx_digital Adapter', function () {
'adm': '<!-- Creative -->',
'crid': '3434abab35',
'h': 600,
'id': '987654321cba',
'id': '987654321dcb',
'price': 0.5,
'ttl': 300,
'w': 300
Expand Down Expand Up @@ -506,25 +556,39 @@ describe('emx_digital Adapter', function () {
});

it('returns a vastXml kvp for video creatives', function () {
serverResponse.seatbid[0].bid[0].adm = '<?xml version=><VAST></VAST></xml>';
serverResponse.seatbid[1].bid[0].adm = '<?xml version=><VAST></VAST></xml>';
const vastServerResponse = utils.deepClone(serverResponse);
vastServerResponse.seatbid[0].bid[0].adm = '<?xml version=><VAST></VAST></xml>';
vastServerResponse.seatbid[1].bid[0].adm = '<?xml version=><VAST></VAST></xml>';

let result = spec.interpretResponse({
body: serverResponse
body: vastServerResponse
}, { bidRequest: bid }
);
const ad0 = result[0];
const ad1 = result[1];
expect(ad0.mediaType).to.equal('video');
expect(ad0.ad.indexOf('<?xml version') > -1).to.equal(true);
expect(ad0.vastXml).to.equal(serverResponse.seatbid[0].bid[0].adm);
expect(ad0.vastXml).to.equal(vastServerResponse.seatbid[0].bid[0].adm);
expect(ad0.ad).to.exist.and.to.be.a('string');
expect(ad1.mediaType).to.equal('video');
expect(ad1.ad.indexOf('<?xml version') > -1).to.equal(true);
expect(ad1.vastXml).to.equal(serverResponse.seatbid[1].bid[0].adm);
expect(ad1.vastXml).to.equal(vastServerResponse.seatbid[1].bid[0].adm);
expect(ad1.ad).to.exist.and.to.be.a('string');
});

it('returns a renderer for outstream video creatives', function () {
const vastServerResponse = utils.deepClone(serverResponse);
vastServerResponse.seatbid[0].bid[0].adm = '<?xml version=><VAST></VAST></xml>';
vastServerResponse.seatbid[1].bid[0].adm = '<?xml version=><VAST></VAST></xml>';
let result = spec.interpretResponse({body: vastServerResponse}, bid_outstream);
const ad0 = result[0];
const ad1 = result[1];
expect(ad0.renderer).to.exist.and.to.be.a('object');
expect(ad0.renderer.url).to.equal('https://js.brealtime.com/outstream/1.30.0/bundle.js');
expect(ad0.renderer.id).to.equal('987654321cba');
expect(ad1.renderer).to.equal(undefined);
});

it('handles nobid responses', function () {
let serverResponse = {
'bids': []
Expand All @@ -537,11 +601,12 @@ describe('emx_digital Adapter', function () {
});

it('should not throw an error when decoding an improperly encoded adm', function () {
serverResponse.seatbid[0].bid[0].adm = '<script\\ src\\=\\\"https\\:\\/\\/nym1\\-ib\\.adnxs\\.com\\/ab\\?an_audit\\=0\\&referrer=https%3A%2F%2Fwww.emxdigital.com%3Ftest%3DhAiE3%VVl%26prebid%3D%25123%25\\&e\\=wqT_3QLPCfBDzwQAAAMA1gAFAQj2iaPtBRCdw\\-qeto72gkEYlNWN2smGoJhTKjYJzGJi83G9KkARzGJi83G9KkAZAAAAgD0KEkAhzGIJGwApESTIMQAAAGBmZu4_MMvWgAc4zApAzApIAlDo\\-YEUWNbsR2AAaIrFCnjOpQWAAQGKAQNVU0SSBQbwQJgB2AWgAVqoAQGwAQC4AQLAAQTIAQLQAQnYAQDgAQDwAQCKAjp1ZignYScsIDI4OTEwMSwgMTU3MTM0MTU1OCk7ARwscicsIDQxOTc1MDE2Nh4A9DQBkgLhAiE3VVlCWndpQmpwOEpFT2o1Z1JRWUFDRFc3RWN3QURnQVFBUkl6QXBReTlhQUIxZ0FZTHdFYUFCd0NuZ0FnQUZFaUFFQWtBRUFtQUVBb0FFQnFBRURzQUVBdVFGS1I2cF9jYjBxUU1FQlNrZXFmM0c5S2tESkFaR1JfRy1UVnRNXzJRRUFBQUFBQUFEd1AtQUJBUFVCQUFBQUFJQUNBSWdDcVlMWEJaQUNBWmdDQUtBQ0FLZ0NBTFVDQUFBQUFMMENBQUFBQU9BQ0FPZ0NBUGdDQUlBREFaZ0RBYWdEZ1k2ZkNib0RDVTVaVFRJNk5ESTRNdUFEOHhQNEE0NnV2Z3lJQkFDUUJBQ1lCQUd5QkFvSXFZTFhCUkNPcnI0TXdRUUFBQUFBQUFBQUFNa0VBQUFBBXgMQURSQgkJLEF3Q0ZBMkFRQThRUQ0SYEFBQVBnRUFJZ0Z1aUUumgKJASE2eElrelE2ZQGgMXV4SElBUW9BREU5Q3RlamNMMHFRRG9KVGxsTk1qbzBNamd5UVBNVFMRWAxQQV9VEQwMQUFBVx0MAFkdDABhHQwAYw0MAaXwi2VBQS7YAqwD4AK30UbqAlxodHRwczovL3d3dy5jZWxlYnV6ei5jb20vZy90YXlsb3Itc3dpZnQtZGVidXRzLXJlZC1oYWlyLWluLXN1Z2FybGFuZC12aWRlby8_YmlkZHJfZGVidWc9dHJ1ZfICEwoPQ1VTVE9NX01PREVMX0lEEgDyAhoKFkNVU1RPERY8TEVBRl9OQU1FEgDyAh4KGjYdAPQqAUFTVF9NT0RJRklFRBIAgAMAiAMBkAMAmAMUoAMBqgMAwAOsAsgDANgDlCHgAwDoAwD4AwOABACSBAkvb3BlbnJ0YjKYBACiBA8xNDQuMTIxLjIzMy4yMzeoBIkWsgQMCAAQABgAIAAwADgAuAQAwAQAyASxgoIB0gQOMTM1NiNOWU0yOjQyODLaBAIIAeAEAPAE6PmBFPoEEgkAAAAAZqdHQBEAAAAgWpRewIgFAZgFAKAF____________AaoFFjQ5MTgxNTcxMzQxNTU2NTI2OTQ5ZTHABQDJBQAAAAAAAPA_0gUJCQAAAAAAAAAA2AUB4AUB8AXW7gr6BQQIABAAkAYAmAYAuAYAwQYAAAAAAADwP8gGANAGwgTaBhYKEAAAAAAAAAAAAAAABQpQEAAYAOAGAfIGAggAgAcBiAcAoAcB\\&s\\=630dbbd55f593c7bfd9e7bccc4dbaa28203daaed\\&pp\\=\\$\\{EMX_MACRO\\}\\\"\\>\\<\\/script\\>';
serverResponse.seatbid[1].bid[0].adm = '%3F%%3Demx%3C3prebid'
const badAdmServerResponse = utils.deepClone(serverResponse);
badAdmServerResponse.seatbid[0].bid[0].adm = '<script\\ src\\=\\\"https\\:\\/\\/nym1\\-ib\\.adnxs\\.com\\/ab\\?an_audit\\=0\\&referrer=https%3A%2F%2Fwww.emxdigital.com%3Ftest%3DhAiE3%VVl%26prebid%3D%25123%25\\&e\\=wqT_3QLPCfBDzwQAAAMA1gAFAQj2iaPtBRCdw\\-qeto72gkEYlNWN2smGoJhTKjYJzGJi83G9KkARzGJi83G9KkAZAAAAgD0KEkAhzGIJGwApESTIMQAAAGBmZu4_MMvWgAc4zApAzApIAlDo\\-YEUWNbsR2AAaIrFCnjOpQWAAQGKAQNVU0SSBQbwQJgB2AWgAVqoAQGwAQC4AQLAAQTIAQLQAQnYAQDgAQDwAQCKAjp1ZignYScsIDI4OTEwMSwgMTU3MTM0MTU1OCk7ARwscicsIDQxOTc1MDE2Nh4A9DQBkgLhAiE3VVlCWndpQmpwOEpFT2o1Z1JRWUFDRFc3RWN3QURnQVFBUkl6QXBReTlhQUIxZ0FZTHdFYUFCd0NuZ0FnQUZFaUFFQWtBRUFtQUVBb0FFQnFBRURzQUVBdVFGS1I2cF9jYjBxUU1FQlNrZXFmM0c5S2tESkFaR1JfRy1UVnRNXzJRRUFBQUFBQUFEd1AtQUJBUFVCQUFBQUFJQUNBSWdDcVlMWEJaQUNBWmdDQUtBQ0FLZ0NBTFVDQUFBQUFMMENBQUFBQU9BQ0FPZ0NBUGdDQUlBREFaZ0RBYWdEZ1k2ZkNib0RDVTVaVFRJNk5ESTRNdUFEOHhQNEE0NnV2Z3lJQkFDUUJBQ1lCQUd5QkFvSXFZTFhCUkNPcnI0TXdRUUFBQUFBQUFBQUFNa0VBQUFBBXgMQURSQgkJLEF3Q0ZBMkFRQThRUQ0SYEFBQVBnRUFJZ0Z1aUUumgKJASE2eElrelE2ZQGgMXV4SElBUW9BREU5Q3RlamNMMHFRRG9KVGxsTk1qbzBNamd5UVBNVFMRWAxQQV9VEQwMQUFBVx0MAFkdDABhHQwAYw0MAaXwi2VBQS7YAqwD4AK30UbqAlxodHRwczovL3d3dy5jZWxlYnV6ei5jb20vZy90YXlsb3Itc3dpZnQtZGVidXRzLXJlZC1oYWlyLWluLXN1Z2FybGFuZC12aWRlby8_YmlkZHJfZGVidWc9dHJ1ZfICEwoPQ1VTVE9NX01PREVMX0lEEgDyAhoKFkNVU1RPERY8TEVBRl9OQU1FEgDyAh4KGjYdAPQqAUFTVF9NT0RJRklFRBIAgAMAiAMBkAMAmAMUoAMBqgMAwAOsAsgDANgDlCHgAwDoAwD4AwOABACSBAkvb3BlbnJ0YjKYBACiBA8xNDQuMTIxLjIzMy4yMzeoBIkWsgQMCAAQABgAIAAwADgAuAQAwAQAyASxgoIB0gQOMTM1NiNOWU0yOjQyODLaBAIIAeAEAPAE6PmBFPoEEgkAAAAAZqdHQBEAAAAgWpRewIgFAZgFAKAF____________AaoFFjQ5MTgxNTcxMzQxNTU2NTI2OTQ5ZTHABQDJBQAAAAAAAPA_0gUJCQAAAAAAAAAA2AUB4AUB8AXW7gr6BQQIABAAkAYAmAYAuAYAwQYAAAAAAADwP8gGANAGwgTaBhYKEAAAAAAAAAAAAAAABQpQEAAYAOAGAfIGAggAgAcBiAcAoAcB\\&s\\=630dbbd55f593c7bfd9e7bccc4dbaa28203daaed\\&pp\\=\\$\\{EMX_MACRO\\}\\\"\\>\\<\\/script\\>';
badAdmServerResponse.seatbid[1].bid[0].adm = '%3F%%3Demx%3C3prebid';

assert.doesNotThrow(() => spec.interpretResponse({
body: serverResponse
body: badAdmServerResponse
}));
});
});
Expand Down