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

rename consentManagement setConfig function and update test page #3849

Merged
merged 1 commit into from
May 28, 2019
Merged

rename consentManagement setConfig function and update test page #3849

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
10 changes: 7 additions & 3 deletions integrationExamples/gpt/gdpr_hello_world.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,13 +82,17 @@

var adUnits = [{
code: 'div-gpt-ad-1460505748561-0',
sizes: [[300, 250], [300,600]],
mediaTypes: {
banner: {
sizes: [[300, 250], [300,600]]
}
},

// Replace this object to test a new Adapter!
bids: [{
bidder: 'appnexusAst',
bidder: 'appnexus',
params: {
placementId: '10433394'
placementId: 13144370
}
}]

Expand Down
4 changes: 2 additions & 2 deletions modules/consentManagement.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -342,7 +342,7 @@ export function resetConsentData() {
* A configuration function that initializes some module variables, as well as add a hook into the requestBids function
* @param {object} config required; consentManagement module config settings; cmp (string), timeout (int), allowAuctionWithoutConsent (boolean)
*/
export function setConfig(config) {
export function setConsentConfig(config) {
if (utils.isStr(config.cmpApi)) {
userCMP = config.cmpApi;
} else {
Expand Down Expand Up @@ -379,4 +379,4 @@ export function setConfig(config) {
}
addedConsentHook = true;
}
config.getConfig('consentManagement', config => setConfig(config.consentManagement));
config.getConfig('consentManagement', config => setConsentConfig(config.consentManagement));
32 changes: 16 additions & 16 deletions test/spec/modules/consentManagement_spec.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import {setConfig, requestBidsHook, resetConsentData, userCMP, consentTimeout, allowAuction, staticConsentData} from 'modules/consentManagement';
import {setConsentConfig, requestBidsHook, resetConsentData, userCMP, consentTimeout, allowAuction, staticConsentData} from 'modules/consentManagement';
import {gdprDataHandler} from 'src/adapterManager';
import * as utils from 'src/utils';
import { config } from 'src/config';
Expand All @@ -7,8 +7,8 @@ let assert = require('chai').assert;
let expect = require('chai').expect;

describe('consentManagement', function () {
describe('setConfig tests:', function () {
describe('empty setConfig value', function () {
describe('setConsentConfig tests:', function () {
describe('empty setConsentConfig value', function () {
beforeEach(function () {
sinon.stub(utils, 'logInfo');
});
Expand All @@ -19,15 +19,15 @@ describe('consentManagement', function () {
});

it('should use system default values', function () {
setConfig({});
setConsentConfig({});
expect(userCMP).to.be.equal('iab');
expect(consentTimeout).to.be.equal(10000);
expect(allowAuction).to.be.true;
sinon.assert.callCount(utils.logInfo, 4);
});
});

describe('valid setConfig value', function () {
describe('valid setConsentConfig value', function () {
afterEach(function () {
config.resetConfig();
$$PREBID_GLOBAL$$.requestBids.removeAll();
Expand All @@ -39,14 +39,14 @@ describe('consentManagement', function () {
allowAuctionWithoutConsent: false
};

setConfig(allConfig);
setConsentConfig(allConfig);
expect(userCMP).to.be.equal('iab');
expect(consentTimeout).to.be.equal(7500);
expect(allowAuction).to.be.false;
});
});

describe('static consent string setConfig value', () => {
describe('static consent string setConsentConfig value', () => {
afterEach(() => {
config.resetConfig();
$$PREBID_GLOBAL$$.requestBids.removeAll();
Expand Down Expand Up @@ -447,7 +447,7 @@ describe('consentManagement', function () {
}
};

setConfig(staticConfig);
setConsentConfig(staticConfig);
expect(userCMP).to.be.equal('static');
expect(consentTimeout).to.be.equal(0); // should always return without a timeout when config is used
expect(allowAuction).to.be.false;
Expand Down Expand Up @@ -495,7 +495,7 @@ describe('consentManagement', function () {
let badCMPConfig = {
cmpApi: 'bad'
};
setConfig(badCMPConfig);
setConsentConfig(badCMPConfig);
expect(userCMP).to.be.equal(badCMPConfig.cmpApi);

requestBidsHook(() => {
Expand All @@ -508,7 +508,7 @@ describe('consentManagement', function () {
});

it('should throw proper errors when CMP is not found', function () {
setConfig(goodConfigWithCancelAuction);
setConsentConfig(goodConfigWithCancelAuction);

requestBidsHook(() => {
didHookReturn = true;
Expand Down Expand Up @@ -546,7 +546,7 @@ describe('consentManagement', function () {
cmpStub = sinon.stub(window, '__cmp').callsFake((...args) => {
args[2](testConsentData);
});
setConfig(goodConfigWithAllowAuction);
setConsentConfig(goodConfigWithAllowAuction);
requestBidsHook(() => {}, {});
cmpStub.restore();

Expand Down Expand Up @@ -610,7 +610,7 @@ describe('consentManagement', function () {
args[2](testConsentData.data.msgName, testConsentData.data);
});

setConfig(goodConfigWithAllowAuction);
setConsentConfig(goodConfigWithAllowAuction);
requestBidsHook(() => {
didHookReturn = true;
}, {adUnits: [{ sizes: [[300, 250]] }]});
Expand Down Expand Up @@ -684,7 +684,7 @@ describe('consentManagement', function () {
function testIFramedPage(testName, messageFormatString) {
it(`should return the consent string from a postmessage + addEventListener response - ${testName}`, (done) => {
stringifyResponse = messageFormatString;
setConfig(goodConfigWithAllowAuction);
setConsentConfig(goodConfigWithAllowAuction);
requestBidsHook(() => {
let consent = gdprDataHandler.getConsentData();
sinon.assert.notCalled(utils.logWarn);
Expand Down Expand Up @@ -726,7 +726,7 @@ describe('consentManagement', function () {
args[2](testConsentData);
});

setConfig(goodConfigWithAllowAuction);
setConsentConfig(goodConfigWithAllowAuction);

requestBidsHook(() => {
didHookReturn = true;
Expand All @@ -748,7 +748,7 @@ describe('consentManagement', function () {
args[2](testConsentData);
});

setConfig(goodConfigWithCancelAuction);
setConsentConfig(goodConfigWithCancelAuction);

requestBidsHook(() => {
didHookReturn = true;
Expand All @@ -768,7 +768,7 @@ describe('consentManagement', function () {
args[2](testConsentData);
});

setConfig(goodConfigWithAllowAuction);
setConsentConfig(goodConfigWithAllowAuction);

requestBidsHook(() => {
didHookReturn = true;
Expand Down