forked from prebid/Prebid.js
-
Notifications
You must be signed in to change notification settings - Fork 0
/
userSync_spec.js
647 lines (599 loc) · 24.8 KB
/
userSync_spec.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
import { expect } from 'chai';
import { config } from 'src/config.js';
import {ruleRegistry} from '../../src/activities/rules.js';
import {ACTIVITY_SYNC_USER} from '../../src/activities/activities.js';
import {
ACTIVITY_PARAM_COMPONENT,
ACTIVITY_PARAM_SYNC_TYPE,
ACTIVITY_PARAM_SYNC_URL
} from '../../src/activities/params.js';
import {MODULE_TYPE_BIDDER} from '../../src/activities/modules.js';
// Use require since we need to be able to write to these vars
const utils = require('../../src/utils');
let { newUserSync, USERSYNC_DEFAULT_CONFIG } = require('../../src/userSync');
describe('user sync', function () {
let triggerPixelStub;
let logWarnStub;
let timeoutStub;
let shuffleStub;
let getUniqueIdentifierStrStub;
let insertUserSyncIframeStub;
let idPrefix = 'test-generated-id-';
let lastId = 0;
let defaultUserSyncConfig = config.getConfig('userSync');
let regRule, isAllowed;
function mkUserSync(deps) {
[regRule, isAllowed] = ruleRegistry();
return newUserSync(Object.assign({
regRule, isAllowed
}, deps))
}
function newTestUserSync(configOverrides, disableBrowserCookies) {
const thisConfig = Object.assign({}, defaultUserSyncConfig, configOverrides);
return mkUserSync({
config: thisConfig,
browserSupportsCookies: !disableBrowserCookies,
})
}
let clock;
before(function () {
clock = sinon.useFakeTimers();
});
after(function () {
clock.restore();
});
beforeEach(function () {
config.setConfig({ userSync: USERSYNC_DEFAULT_CONFIG });
triggerPixelStub = sinon.stub(utils, 'triggerPixel');
logWarnStub = sinon.stub(utils, 'logWarn');
shuffleStub = sinon.stub(utils, 'shuffle').callsFake((array) => array.reverse());
getUniqueIdentifierStrStub = sinon.stub(utils, 'getUniqueIdentifierStr').callsFake(() => idPrefix + (lastId += 1));
insertUserSyncIframeStub = sinon.stub(utils, 'insertUserSyncIframe');
});
afterEach(function () {
triggerPixelStub.restore();
logWarnStub.restore();
shuffleStub.restore();
getUniqueIdentifierStrStub.restore();
insertUserSyncIframeStub.restore();
config.resetConfig();
});
it('should register and fire a pixel URL', function () {
const userSync = newTestUserSync();
userSync.registerSync('image', 'testBidder', 'http://example.com');
userSync.syncUsers();
expect(triggerPixelStub.getCall(0)).to.not.be.null;
expect(triggerPixelStub.getCall(0).args[0]).to.exist.and.to.equal('http://example.com');
});
it('should NOT fire a sync if a rule blocks syncUser', () => {
const userSync = newTestUserSync()
regRule(ACTIVITY_SYNC_USER, 'testRule', (params) => {
if (
params[ACTIVITY_PARAM_COMPONENT] === `${MODULE_TYPE_BIDDER}.testBidder` &&
params[ACTIVITY_PARAM_SYNC_TYPE] === 'image' &&
params[ACTIVITY_PARAM_SYNC_URL] === 'http://example.com'
) {
return {allow: false}
}
})
userSync.registerSync('image', 'testBidder', 'http://example.com');
userSync.syncUsers();
expect(triggerPixelStub.called).to.be.false;
})
it('should clear queue after sync', function () {
const userSync = newTestUserSync();
userSync.syncUsers();
expect(triggerPixelStub.callCount).to.equal(0);
});
it('should delay firing a pixel by the expected amount', function () {
const userSync = newTestUserSync();
userSync.registerSync('image', 'testBidder', 'http://example.com');
// This implicitly tests cookie and browser support
userSync.syncUsers(999);
clock.tick(1000);
expect(triggerPixelStub.getCall(0)).to.not.be.null;
});
it('should register and fires multiple pixel URLs', function () {
const userSync = newTestUserSync();
userSync.registerSync('image', 'testBidder', 'http://example.com/1');
userSync.registerSync('image', 'testBidder', 'http://example.com/2');
userSync.syncUsers();
expect(triggerPixelStub.getCall(0)).to.not.be.null;
expect(triggerPixelStub.getCall(0).args[0]).to.exist.and.to.include('http://example.com/');
expect(triggerPixelStub.getCall(1)).to.not.be.null;
expect(triggerPixelStub.getCall(1).args[0]).to.exist.and.to.include('http://example.com/');
expect(triggerPixelStub.getCall(2)).to.be.null;
});
it('should not register pixel URL since it is not supported', function () {
const userSync = newTestUserSync({filterSettings: {
image: {
bidders: '*',
filter: 'exclude'
}
}});
userSync.registerSync('image', 'testBidder', 'http://example.com');
userSync.syncUsers();
expect(triggerPixelStub.getCall(0)).to.be.null;
});
it('should register and load an iframe', function () {
const userSync = newTestUserSync({filterSettings: {
iframe: {
bidders: '*',
filter: 'include'
}
}});
userSync.registerSync('iframe', 'testBidder', 'http://example.com/iframe');
userSync.syncUsers();
expect(insertUserSyncIframeStub.getCall(0).args[0]).to.equal('http://example.com/iframe');
});
it('should stop triggering user syncs after bidderDone', function () {
const userSync = newTestUserSync({ pixelEnabled: true });
userSync.registerSync('image', 'testBidder', 'http://example.com/1');
userSync.bidderDone('testBidder');
userSync.syncUsers();
userSync.registerSync('image', 'testBidder', 'http://example.com/2');
userSync.registerSync('image', 'testBidder2', 'http://example.com/3');
userSync.syncUsers();
expect(triggerPixelStub.callCount).to.equal(2);
expect(triggerPixelStub.getCall(0)).to.not.be.null;
expect(triggerPixelStub.getCall(0).args[0]).to.exist.and.to.equal('http://example.com/1');
expect(triggerPixelStub.getCall(1)).to.not.be.null;
expect(triggerPixelStub.getCall(1).args[0]).to.exist.and.to.equal('http://example.com/3');
});
it('should not fire syncs if cookies are not supported', function () {
const userSync = newTestUserSync({ pixelEnabled: true }, true);
userSync.registerSync('image', 'testBidder', 'http://example.com');
userSync.syncUsers();
expect(triggerPixelStub.getCall(0)).to.be.null;
});
it('should prevent registering invalid type', function () {
const userSync = newTestUserSync();
userSync.registerSync('invalid', 'testBidder', 'http://example.com');
expect(logWarnStub.getCall(0).args[0]).to.exist;
});
it('should expose the syncUsers method for the publisher to manually trigger syncs', function () {
// triggerUserSyncs should do nothing by default
let userSync = newTestUserSync();
let syncUsersSpy = sinon.spy(userSync, 'syncUsers');
userSync.triggerUserSyncs();
expect(syncUsersSpy.notCalled).to.be.true;
// triggerUserSyncs should trigger syncUsers if enableOverride is on
userSync = newTestUserSync({ enableOverride: true });
syncUsersSpy = sinon.spy(userSync, 'syncUsers');
userSync.triggerUserSyncs();
expect(syncUsersSpy.called).to.be.true;
});
it('should limit the number of syncs per bidder', function () {
const userSync = newTestUserSync({ syncsPerBidder: 2 });
userSync.registerSync('image', 'testBidder', 'http://example.com/1');
userSync.registerSync('image', 'testBidder', 'http://example.com/2');
userSync.registerSync('image', 'testBidder', 'http://example.com/3');
userSync.syncUsers();
expect(triggerPixelStub.getCall(0)).to.not.be.null;
expect(triggerPixelStub.getCall(0).args[0]).to.exist.and.to.match(/^http:\/\/example\.com\/[1|2]/);
expect(triggerPixelStub.getCall(1)).to.not.be.null;
expect(triggerPixelStub.getCall(1).args[0]).to.exist.and.to.match(/^http:\/\/example\.com\/[1|2]/);
expect(triggerPixelStub.getCall(2)).to.be.null;
});
it('should not limit the number of syncs per bidder when set to 0', function () {
const userSync = newTestUserSync({ syncsPerBidder: 0 });
userSync.registerSync('image', 'testBidder', 'http://example.com/1');
userSync.registerSync('image', 'testBidder', 'http://example.com/2');
userSync.registerSync('image', 'testBidder', 'http://example.com/3');
userSync.syncUsers();
expect(triggerPixelStub.getCall(0)).to.not.be.null;
expect(triggerPixelStub.getCall(0).args[0]).to.exist.and.to.match(/^http:\/\/example\.com\/[1|2|3]/);
expect(triggerPixelStub.getCall(1)).to.not.be.null;
expect(triggerPixelStub.getCall(1).args[0]).to.exist.and.to.match(/^http:\/\/example\.com\/[1|2|3]/);
expect(triggerPixelStub.getCall(2)).to.not.be.null;
expect(triggerPixelStub.getCall(2).args[0]).to.exist.and.to.match(/^http:\/\/example\.com\/[1|2|3]/);
});
it('should balance out bidder requests', function () {
const userSync = newTestUserSync();
userSync.registerSync('image', 'atestBidder', 'http://example.com/1');
userSync.registerSync('image', 'atestBidder', 'http://example.com/3');
userSync.registerSync('image', 'btestBidder', 'http://example.com/2');
userSync.syncUsers();
// The stubbed shuffle function should just reverse the order
expect(triggerPixelStub.getCall(0)).to.not.be.null;
expect(triggerPixelStub.getCall(0).args[0]).to.exist.and.to.equal('http://example.com/2');
expect(triggerPixelStub.getCall(1)).to.not.be.null;
expect(triggerPixelStub.getCall(1).args[0]).to.exist.and.to.equal('http://example.com/3');
expect(triggerPixelStub.getCall(2)).to.not.be.null;
expect(triggerPixelStub.getCall(2).args[0]).to.exist.and.to.equal('http://example.com/1');
expect(triggerPixelStub.getCall(3)).to.be.null;
});
it('should disable user sync', function () {
const userSync = newTestUserSync({ syncEnabled: false });
userSync.registerSync('pixel', 'testBidder', 'http://example.com');
expect(logWarnStub.getCall(0).args[0]).to.exist;
userSync.syncUsers();
expect(triggerPixelStub.getCall(0)).to.be.null;
});
it('should only sync enabled bidders', function () {
const userSync = newTestUserSync({filterSettings: {
image: {
bidders: ['testBidderA'],
filter: 'include'
}
}});
userSync.registerSync('image', 'testBidderA', 'http://example.com/1');
userSync.registerSync('image', 'testBidderB', 'http://example.com/2');
userSync.syncUsers();
expect(triggerPixelStub.getCall(0)).to.not.be.null;
expect(triggerPixelStub.getCall(0).args[0]).to.exist.and.to.include('http://example.com/');
expect(triggerPixelStub.getCall(1)).to.be.null;
});
it('should register config set after instantiation', function () {
// start with userSync off
const userSync = newTestUserSync({ syncEnabled: false });
// turn it on with setConfig()
config.setConfig({ userSync: { syncEnabled: true } });
userSync.registerSync('image', 'testBidder', 'http://example.com');
userSync.syncUsers();
expect(triggerPixelStub.getCall(0)).to.not.be.null;
expect(triggerPixelStub.getCall(0).args[0]).to.exist.and.to.equal('http://example.com');
});
it('should register both image and iframe pixels with filterSettings.all config', function () {
const userSync = newTestUserSync({
filterSettings: {
all: {
bidders: ['atestBidder', 'testBidder'],
filter: 'include'
},
}
});
userSync.registerSync('image', 'atestBidder', 'http://example.com/1');
userSync.registerSync('iframe', 'testBidder', 'http://example.com/iframe');
userSync.syncUsers();
expect(triggerPixelStub.getCall(0)).to.not.be.null;
expect(triggerPixelStub.getCall(0).args[0]).to.exist.and.to.equal('http://example.com/1');
expect(insertUserSyncIframeStub.getCall(0)).to.not.be.null;
expect(insertUserSyncIframeStub.getCall(0).args[0]).to.equal('http://example.com/iframe');
});
it('should register iframe and not register image pixels based on filterSettings config', function () {
const userSync = newTestUserSync({
filterSettings: {
image: {
bidders: '*',
filter: 'exclude'
},
iframe: {
bidders: ['testBidder']
}
}
});
userSync.registerSync('image', 'atestBidder', 'http://example.com/1');
userSync.registerSync('iframe', 'testBidder', 'http://example.com/iframe');
userSync.syncUsers();
expect(triggerPixelStub.getCall(0)).to.be.null;
expect(insertUserSyncIframeStub.getCall(0)).to.not.be.null;
expect(insertUserSyncIframeStub.getCall(0).args[0]).to.equal('http://example.com/iframe');
});
it('should throw a warning and default to basic resgistration rules when filterSettings config is invalid', function () {
// invalid config - passed invalid filter option
const userSync1 = newTestUserSync({
filterSettings: {
iframe: {
bidders: ['testBidder'],
filter: 'includes'
}
}
});
userSync1.registerSync('image', 'atestBidder', 'http://example.com/1');
userSync1.registerSync('iframe', 'testBidder', 'http://example.com/iframe');
userSync1.syncUsers();
expect(logWarnStub.getCall(0).args[0]).to.exist;
expect(triggerPixelStub.getCall(0)).to.not.be.null;
expect(triggerPixelStub.getCall(0).args[0]).to.exist.and.to.equal('http://example.com/1');
expect(insertUserSyncIframeStub.getCall(0)).to.be.null;
// invalid config - bidders is not an array of strings
const userSync2 = newTestUserSync({
filterSettings: {
iframe: {
bidders: ['testBidder', 0],
filter: 'include'
}
}
});
userSync2.registerSync('image', 'atestBidder', 'http://example.com/1');
userSync2.registerSync('iframe', 'testBidder', 'http://example.com/iframe');
userSync2.syncUsers();
expect(logWarnStub.getCall(1).args[0]).to.exist;
expect(triggerPixelStub.getCall(1)).to.not.be.null;
expect(triggerPixelStub.getCall(1).args[0]).to.exist.and.to.equal('http://example.com/1');
expect(insertUserSyncIframeStub.getCall(0)).to.be.null;
// invalid config - bidders list includes wildcard
const userSync3 = newTestUserSync({
filterSettings: {
iframe: {
bidders: ['testBidder', '*'],
filter: 'include'
}
}
});
userSync3.registerSync('image', 'atestBidder', 'http://example.com/1');
userSync3.registerSync('iframe', 'testBidder', 'http://example.com/iframe');
userSync3.syncUsers();
expect(logWarnStub.getCall(2).args[0]).to.exist;
expect(triggerPixelStub.getCall(2)).to.not.be.null;
expect(triggerPixelStub.getCall(2).args[0]).to.exist.and.to.equal('http://example.com/1');
expect(insertUserSyncIframeStub.getCall(0)).to.be.null;
// invalid config - incorrect wildcard
const userSync4 = newTestUserSync({
filterSettings: {
iframe: {
bidders: '***',
filter: 'include'
}
}
});
userSync4.registerSync('image', 'atestBidder', 'http://example.com/1');
userSync4.registerSync('iframe', 'testBidder', 'http://example.com/iframe');
userSync4.syncUsers();
expect(logWarnStub.getCall(3).args[0]).to.exist;
expect(triggerPixelStub.getCall(3)).to.not.be.null;
expect(triggerPixelStub.getCall(3).args[0]).to.exist.and.to.equal('http://example.com/1');
expect(insertUserSyncIframeStub.getCall(0)).to.be.null;
// invalid config - missing bidders field
const userSync5 = newTestUserSync({
filterSettings: {
iframe: {
filter: 'include'
}
}
});
userSync5.registerSync('image', 'atestBidder', 'http://example.com/1');
userSync5.registerSync('iframe', 'testBidder', 'http://example.com/iframe');
userSync5.syncUsers();
expect(logWarnStub.getCall(4).args[0]).to.exist;
expect(triggerPixelStub.getCall(4)).to.not.be.null;
expect(triggerPixelStub.getCall(4).args[0]).to.exist.and.to.equal('http://example.com/1');
expect(insertUserSyncIframeStub.getCall(0)).to.be.null;
});
it('should overwrite logic of deprecated fields when filterSettings is defined', function () {
const userSync = newTestUserSync({
pixelsEnabled: false,
iframeEnabled: true,
enabledBidders: ['ctestBidder'],
filterSettings: {
image: {
bidders: '*',
filter: 'include'
},
iframe: {
bidders: ['testBidder'],
filter: 'exclude'
}
}
});
userSync.registerSync('image', 'atestBidder', 'http://example.com/1');
userSync.registerSync('iframe', 'testBidder', 'http://example.com/iframe');
userSync.syncUsers();
expect(triggerPixelStub.getCall(0)).to.not.be.null;
expect(triggerPixelStub.getCall(0).args[0]).to.exist.and.to.equal('http://example.com/1');
expect(insertUserSyncIframeStub.getCall(0)).to.be.null;
});
it('should still allow default image syncs if setConfig only defined iframe', function () {
const userSync = mkUserSync({
config: config.getConfig('userSync'),
browserSupportsCookies: true
});
config.setConfig({
userSync: {
filterSettings: {
iframe: {
bidders: ['bidderXYZ'],
filter: 'include'
}
}
}
});
userSync.registerSync('image', 'testBidder', 'http://example.com');
userSync.registerSync('iframe', 'bidderXYZ', 'http://example.com/iframe');
userSync.syncUsers();
expect(triggerPixelStub.getCall(0)).to.not.be.null;
expect(triggerPixelStub.getCall(0).args[0]).to.exist.and.to.equal('http://example.com');
expect(insertUserSyncIframeStub.getCall(0).args[0]).to.equal('http://example.com/iframe');
});
it('should not fire image pixel for a bidder if iframe pixel is fired for same bidder', function() {
const userSync = mkUserSync({
config: config.getConfig('userSync'),
browserSupportsCookies: true
});
config.setConfig({
userSync: {
filterSettings: {
iframe: {
bidders: ['bidderXYZ'],
filter: 'include'
}
}
}
});
// we are registering iframe and image sync for bidderXYZ and we expect image sync not to execute.
userSync.registerSync('image', 'testBidder', 'http://testBidder.example.com/image');
userSync.registerSync('iframe', 'bidderXYZ', 'http://bidderXYZ.example.com/iframe');
userSync.registerSync('image', 'bidderXYZ', 'http://bidderXYZ.example.com/image');
userSync.syncUsers();
expect(triggerPixelStub.getCall(0)).to.not.be.null;
expect(triggerPixelStub.getCall(0).args[0]).to.exist.and.to.equal('http://testBidder.example.com/image');
expect(triggerPixelStub.callCount).to.equal(1); // should not be 2 for 2 registered image syncs
expect(insertUserSyncIframeStub.getCall(0).args[0]).to.equal('http://bidderXYZ.example.com/iframe');
});
it('should override default image syncs if setConfig used image filter', function () {
const userSync = mkUserSync({
config: config.getConfig('userSync'),
browserSupportsCookies: true
});
config.setConfig({
userSync: {
filterSettings: {
image: {
bidders: ['bidderXYZ'],
filter: 'exclude'
}
}
}
});
userSync.registerSync('image', 'testBidder', 'http://example.com');
userSync.registerSync('image', 'bidderXYZ', 'http://example.com/image-blocked');
userSync.syncUsers();
expect(triggerPixelStub.getCall(0)).to.not.be.null;
expect(triggerPixelStub.getCall(0).args[0]).to.exist.and.to.equal('http://example.com');
expect(triggerPixelStub.getCall(1)).to.be.null;
});
it('should override default image syncs if setConfig used all filter', function() {
const userSync = mkUserSync({
config: config.getConfig('userSync'),
browserSupportsCookies: true
});
config.setConfig({
userSync: {
filterSettings: {
all: {
bidders: ['bidderXYZ'],
filter: 'exclude'
}
}
}
});
userSync.registerSync('image', 'testBidder', 'http://example.com');
userSync.registerSync('image', 'bidderXYZ', 'http://example.com/image-blocked');
userSync.registerSync('iframe', 'testBidder', 'http://example.com/iframe');
userSync.registerSync('iframe', 'bidderXYZ', 'http://example.com/iframe-blocked');
userSync.syncUsers();
// expect(triggerPixelStub.getCall(0)).to.not.be.null;
expect(triggerPixelStub.getCall(0)).to.be.null;// image sync will not execute as iframe sync has executed for same bidder
// expect(triggerPixelStub.getCall(0).args[0]).to.exist.and.to.equal('http://example.com');
expect(triggerPixelStub.getCall(1)).to.be.null;
expect(insertUserSyncIframeStub.getCall(0).args[0]).to.equal('http://example.com/iframe');
expect(insertUserSyncIframeStub.getCall(1)).to.be.null;
});
describe('publicAPI', function () {
describe('canBidderRegisterSync', function () {
describe('with filterSettings', function () {
it('should return false if filter settings does not allow it', function () {
const userSync = mkUserSync({
config: {
filterSettings: {
image: {
bidders: '*',
filter: 'include'
},
iframe: {
bidders: ['testBidder'],
filter: 'include'
}
}
}
});
expect(userSync.canBidderRegisterSync('iframe', 'otherTestBidder')).to.equal(false);
});
it('should return false for iframe if there is no iframe filterSettings', function () {
const userSync = mkUserSync({
config: {
syncEnabled: true,
filterSettings: {
image: {
bidders: '*',
filter: 'include'
}
},
syncsPerBidder: 5,
syncDelay: 3000,
auctionDelay: 0
}
});
expect(userSync.canBidderRegisterSync('iframe', 'otherTestBidder')).to.equal(false);
});
it('should return true if filter settings does allow it', function () {
const userSync = mkUserSync({
config: {
filterSettings: {
image: {
bidders: '*',
filter: 'include'
},
iframe: {
bidders: ['testBidder'],
filter: 'include'
}
}
}
});
expect(userSync.canBidderRegisterSync('iframe', 'testBidder')).to.equal(true);
});
});
describe('almost deprecated - without filterSettings', function () {
describe('enabledBidders contains testBidder', function () {
it('should return false if type is iframe and iframeEnabled is false', function () {
const userSync = mkUserSync({
config: {
filterSettings: {
iframe: {
bidders: ['testBidder'],
filter: 'exclude'
}
}
}
});
expect(userSync.canBidderRegisterSync('iframe', 'testBidder')).to.equal(false);
});
it('should return true if type is iframe and iframeEnabled is true', function () {
const userSync = mkUserSync({
config: {
pixelEnabled: true,
iframeEnabled: true,
enabledBidders: ['testBidder'],
}
});
expect(userSync.canBidderRegisterSync('iframe', 'testBidder')).to.equal(true);
});
it('should return false if type is image and pixelEnabled is false', function () {
const userSync = mkUserSync({
config: {
filterSettings: {
image: {
bidders: ['testBidder'],
filter: 'exclude'
}
}
}
});
expect(userSync.canBidderRegisterSync('image', 'testBidder')).to.equal(false);
});
it('should return true if type is image and pixelEnabled is true', function () {
const userSync = mkUserSync({
config: {
pixelEnabled: true,
iframeEnabled: true,
enabledBidders: ['testBidder'],
}
});
expect(userSync.canBidderRegisterSync('image', 'testBidder')).to.equal(true);
});
});
describe('enabledBidders does not container testBidder', function () {
it('should return false since testBidder is not in enabledBidders', function () {
const userSync = mkUserSync({
config: {
filterSettings: {
image: {
bidders: ['otherTestBidder'],
filter: 'include'
},
iframe: {
bidders: ['otherTestBidder'],
filter: 'include'
}
}
}
});
expect(userSync.canBidderRegisterSync('iframe', 'testBidder')).to.equal(false);
});
});
});
});
});
});