prebid.js 9.1.0 → 9.2.0

package/test/spec/modules/topicsFpdModule_spec.js

@@ -308,33 +308,6 @@ describe('topics', () => {
       }],
       name: 'ads.pubmatic.com'
     }];
-    const consentString = 'CPi8wgAPi8wgAADABBENCrCsAP_AAH_AAAAAISNB7D==';
-    const consentConfig = {
-      consentString: consentString,
-      gdprApplies: true,
-      vendorData: {
-        metadata: consentString,
-        gdprApplies: true,
-        purpose: {
-          consents: {
-            1: true,
-            2: true,
-            3: true,
-            4: true
-          }
-        }
-      }
-    };
-    const mockData = [
-      {
-        name: 'domain',
-        segment: [{id: 123}]
-      },
-      {
-        name: 'domain',
-        segment: [{id: 321}],
-      }
-    ];
 
     const evt = {
       data: '{"segment":{"domain":"ads.pubmatic.com","topics":[{"configVersion":"chrome.1","modelVersion":"2206021246","taxonomyVersion":"1","topic":165,"version":"chrome.1:1:2206021246"}],"bidder":"pubmatic"},"date":1669743901858}',
@@ -345,49 +318,60 @@ describe('topics', () => {
       storage.removeDataFromLocalStorage(topicStorageName);
     });
 
-    describe('when cached data is available and not expired', () => {
+    describe('caching', () => {
       let sandbox;
       beforeEach(() => {
         sandbox = sinon.sandbox.create();
-        const storedSegments = JSON.stringify(
-          [['pubmatic', {
-            '2206021246': {
-              'ext': {'segtax': 600, 'segclass': '2206021246'},
-              'segment': [{'id': '243'}, {'id': '265'}],
-              'name': 'ads.pubmatic.com'
-            },
-            'lastUpdated': new Date().getTime()
-          }]]
-        );
-        storage.setDataInLocalStorage(topicStorageName, storedSegments);
-        config.setConfig({
-          userSync: {
-            topics: {
-              maxTopicCaller: 4,
-              bidders: [{
-                bidder: 'pubmatic',
-                iframeURL: 'https://ads.pubmatic.com/AdServer/js/topics/topics_frame.html'
-              }]
-            }
-          }
-        })
-      });
+      })
+
       afterEach(() => {
         sandbox.restore();
         config.resetConfig();
       });
 
-      it('should return segments for bidder if transmitUfpd is allowed', () => {
-        assert.deepEqual(getCachedTopics(), expected);
-      });
+      it('should return no segments when not configured', () => {
+        config.setConfig({userSync: {}});
+        expect(getCachedTopics()).to.eql([]);
+      })
+
+      describe('when cached data is available and not expired', () => {
+        beforeEach(() => {
+          const storedSegments = JSON.stringify(
+            [['pubmatic', {
+              '2206021246': {
+                'ext': {'segtax': 600, 'segclass': '2206021246'},
+                'segment': [{'id': '243'}, {'id': '265'}],
+                'name': 'ads.pubmatic.com'
+              },
+              'lastUpdated': new Date().getTime()
+            }]]
+          );
+          storage.setDataInLocalStorage(topicStorageName, storedSegments);
+          config.setConfig({
+            userSync: {
+              topics: {
+                maxTopicCaller: 4,
+                bidders: [{
+                  bidder: 'pubmatic',
+                  iframeURL: 'https://ads.pubmatic.com/AdServer/js/topics/topics_frame.html'
+                }]
+              }
+            }
+          })
+        });
 
-      it('should NOT return segments for bidder if enrichUfpd is NOT allowed', () => {
-        sandbox.stub(activities, 'isActivityAllowed').callsFake((activity, params) => {
-          return !(activity === ACTIVITY_ENRICH_UFPD && params.component === 'bidder.pubmatic');
+        it('should return segments for bidder if transmitUfpd is allowed', () => {
+          assert.deepEqual(getCachedTopics(), expected);
+        });
+
+        it('should NOT return segments for bidder if enrichUfpd is NOT allowed', () => {
+          sandbox.stub(activities, 'isActivityAllowed').callsFake((activity, params) => {
+            return !(activity === ACTIVITY_ENRICH_UFPD && params.component === 'bidder.pubmatic');
+          });
+          expect(getCachedTopics()).to.eql([]);
         });
-        expect(getCachedTopics()).to.eql([]);
       });
-    })
+    });
 
     it('should return empty segments for bidder if there is cached segments stored which is expired', () => {
       let storedSegments = '[["pubmatic",{"2206021246":{"ext":{"segtax":600,"segclass":"2206021246"},"segment":[{"id":"243"},{"id":"265"}],"name":"ads.pubmatic.com"},"lastUpdated":10}]]';

package/test/spec/modules/visiblemeasuresBidAdapter_spec.js

@@ -3,11 +3,21 @@ import { spec } from '../../../modules/visiblemeasuresBidAdapter.js';
 import { BANNER, VIDEO, NATIVE } from '../../../src/mediaTypes.js';
 import { getUniqueIdentifierStr } from '../../../src/utils.js';
 
-const bidder = 'visiblemeasures'
+const bidder = 'visiblemeasures';
 const adUrl = 'https://us-e.visiblemeasures.com/pbjs';
 const syncUrl = 'https://cs.visiblemeasures.com';
 
 describe('VisibleMeasuresBidAdapter', function () {
+  const userIdAsEids = [{
+    source: 'test.org',
+    uids: [{
+      id: '01**********',
+      atype: 1,
+      ext: {
+        third: '01***********'
+      }
+    }]
+  }];
   const bids = [
     {
       bidId: getUniqueIdentifierStr(),
@@ -18,8 +28,9 @@ describe('VisibleMeasuresBidAdapter', function () {
         }
       },
       params: {
-        placementId: 'testBanner',
-      }
+        placementId: 'testBanner'
+      },
+      userIdAsEids
     },
     {
       bidId: getUniqueIdentifierStr(),
@@ -32,8 +43,9 @@ describe('VisibleMeasuresBidAdapter', function () {
         }
       },
       params: {
-        placementId: 'testVideo',
-      }
+        placementId: 'testVideo'
+      },
+      userIdAsEids
     },
     {
       bidId: getUniqueIdentifierStr(),
@@ -55,8 +67,9 @@ describe('VisibleMeasuresBidAdapter', function () {
         }
       },
       params: {
-        placementId: 'testNative',
-      }
+        placementId: 'testNative'
+      },
+      userIdAsEids
     }
   ];
 
@@ -75,9 +88,20 @@ describe('VisibleMeasuresBidAdapter', function () {
 
   const bidderRequest = {
     uspConsent: '1---',
-    gdprConsent: 'COvFyGBOvFyGBAbAAAENAPCAAOAAAAAAAAAAAEEUACCKAAA.IFoEUQQgAIQwgIwQABAEAAAAOIAACAIAAAAQAIAgEAACEAAAAAgAQBAAAAAAAGBAAgAAAAAAAFAAECAAAgAAQARAEQAAAAAJAAIAAgAAAYQEAAAQmAgBC3ZAYzUw',
+    gdprConsent: {
+      consentString: 'COvFyGBOvFyGBAbAAAENAPCAAOAAAAAAAAAAAEEUACCKAAA.IFoEUQQgAIQwgIwQABAEAAAAOIAACAIAAAAQAIAgEAACEAAAAAgAQBAAAAAAAGBAAgAAAAAAAFAAECAAAgAAQARAEQAAAAAJAAIAAgAAAYQEAAAQmAgBC3ZAYzUw',
+      vendorData: {}
+    },
     refererInfo: {
-      referer: 'https://test.com'
+      referer: 'https://test.com',
+      page: 'https://test.com'
+    },
+    ortb2: {
+      device: {
+        w: 1512,
+        h: 982,
+        language: 'en-UK'
+      }
     },
     timeout: 500
   };
@@ -131,7 +155,7 @@ describe('VisibleMeasuresBidAdapter', function () {
       expect(data.host).to.be.a('string');
       expect(data.page).to.be.a('string');
       expect(data.coppa).to.be.a('number');
-      expect(data.gdpr).to.be.a('string');
+      expect(data.gdpr).to.be.a('object');
       expect(data.ccpa).to.be.a('string');
       expect(data.tmax).to.be.a('number');
       expect(data.placements).to.have.lengthOf(3);
@@ -147,6 +171,56 @@ describe('VisibleMeasuresBidAdapter', 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.deep.equal(userIdAsEids);
+
+        if (placement.adFormat === BANNER) {
+          expect(placement.sizes).to.be.an('array');
+        }
+        switch (placement.adFormat) {
+          case BANNER:
+            expect(placement.sizes).to.be.an('array');
+            break;
+          case VIDEO:
+            expect(placement.playerSize).to.be.an('array');
+            expect(placement.minduration).to.be.an('number');
+            expect(placement.maxduration).to.be.an('number');
+            break;
+          case NATIVE:
+            expect(placement.native).to.be.an('object');
+            break;
+        }
+      }
+    });
+
+    it('Returns valid endpoints', function () {
+      const bids = [
+        {
+          bidId: getUniqueIdentifierStr(),
+          bidder: bidder,
+          mediaTypes: {
+            [BANNER]: {
+              sizes: [[300, 250]]
+            }
+          },
+          params: {
+            endpointId: 'testBanner',
+          },
+          userIdAsEids
+        }
+      ];
+
+      let serverRequest = spec.buildRequests(bids, bidderRequest);
+
+      const { placements } = serverRequest.data;
+      for (let i = 0, len = placements.length; i < len; i++) {
+        const placement = placements[i];
+        expect(placement.endpointId).to.be.oneOf(['testBanner', 'testVideo', 'testNative']);
+        expect(placement.adFormat).to.be.oneOf([BANNER, VIDEO, NATIVE]);
+        expect(placement.bidId).to.be.a('string');
+        expect(placement.schain).to.be.an('object');
+        expect(placement.bidfloor).to.exist.and.to.equal(0);
+        expect(placement.type).to.exist.and.to.equal('network');
+        expect(placement.eids).to.exist.and.to.be.deep.equal(userIdAsEids);
 
         if (placement.adFormat === BANNER) {
           expect(placement.sizes).to.be.an('array');
@@ -172,8 +246,10 @@ describe('VisibleMeasuresBidAdapter', function () {
       serverRequest = spec.buildRequests(bids, bidderRequest);
       let data = serverRequest.data;
       expect(data.gdpr).to.exist;
-      expect(data.gdpr).to.be.a('string');
-      expect(data.gdpr).to.equal(bidderRequest.gdprConsent);
+      expect(data.gdpr).to.be.a('object');
+      expect(data.gdpr).to.have.property('consentString');
+      expect(data.gdpr).to.not.have.property('vendorData');
+      expect(data.gdpr.consentString).to.equal(bidderRequest.gdprConsent.consentString);
       expect(data.ccpa).to.not.exist;
       delete bidderRequest.gdprConsent;
     });
@@ -188,12 +264,38 @@ describe('VisibleMeasuresBidAdapter', function () {
       expect(data.ccpa).to.equal(bidderRequest.uspConsent);
       expect(data.gdpr).to.not.exist;
     });
+  });
+
+  describe('gpp consent', function () {
+    it('bidderRequest.gppConsent', () => {
+      bidderRequest.gppConsent = {
+        gppString: 'abc123',
+        applicableSections: [8]
+      };
 
-    it('Returns empty data if no valid requests are passed', function () {
-      serverRequest = spec.buildRequests([], bidderRequest);
+      let serverRequest = spec.buildRequests(bids, bidderRequest);
       let data = serverRequest.data;
-      expect(data.placements).to.be.an('array').that.is.empty;
-    });
+      expect(data).to.be.an('object');
+      expect(data).to.have.property('gpp');
+      expect(data).to.have.property('gpp_sid');
+
+      delete bidderRequest.gppConsent;
+    })
+
+    it('bidderRequest.ortb2.regs.gpp', () => {
+      bidderRequest.ortb2 = bidderRequest.ortb2 || {};
+      bidderRequest.ortb2.regs = bidderRequest.ortb2.regs || {};
+      bidderRequest.ortb2.regs.gpp = 'abc123';
+      bidderRequest.ortb2.regs.gpp_sid = [8];
+
+      let serverRequest = spec.buildRequests(bids, bidderRequest);
+      let data = serverRequest.data;
+      expect(data).to.be.an('object');
+      expect(data).to.have.property('gpp');
+      expect(data).to.have.property('gpp_sid');
+
+      bidderRequest.ortb2;
+    })
   });
 
   describe('interpretResponse', function () {
@@ -397,5 +499,17 @@ describe('VisibleMeasuresBidAdapter', function () {
       expect(syncData[0].url).to.be.a('string')
       expect(syncData[0].url).to.equal(`${syncUrl}/image?pbjs=1&ccpa_consent=1---&coppa=0`)
     });
+    it('Should return array of objects with proper sync config , include GPP', function() {
+      const syncData = spec.getUserSyncs({}, {}, {}, {}, {
+        gppString: 'abc123',
+        applicableSections: [8]
+      });
+      expect(syncData).to.be.an('array').which.is.not.empty;
+      expect(syncData[0]).to.be.an('object')
+      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(`${syncUrl}/image?pbjs=1&gpp=abc123&gpp_sid=8&coppa=0`);
+    });
   });
 });

package/test/spec/ortbConverter/converter_spec.js

@@ -80,6 +80,7 @@ describe('pbjs-ortb converter', () => {
             if (context.reqContext?.ctx) {
               bidResponse.reqCtx = context.reqContext?.ctx;
             }
+            bidResponse.seatbid = context.seatbid;
           }
         }
       },
@@ -116,13 +117,16 @@ describe('pbjs-ortb converter', () => {
     const response = cvt.fromORTB({request, response: MOCK_ORTB_RESPONSE});
     expect(response.bids).to.eql([{
       impid: 'imp0',
-      bidId: 111
+      bidId: 111,
+      seatbid: MOCK_ORTB_RESPONSE.seatbid[0]
     }, {
       impid: 'imp1',
-      bidId: 112
+      bidId: 112,
+      seatbid: MOCK_ORTB_RESPONSE.seatbid[0]
     }, {
       impid: 'imp1',
-      bidId: 112
+      bidId: 112,
+      seatbid: MOCK_ORTB_RESPONSE.seatbid[1]
     }]);
     expect(response.marker).to.be.true;
   });

package/test/spec/unit/utils/focusTimeout_spec.js

@@ -0,0 +1,60 @@
+import setFocusTimeout from '../../../../src/utils/focusTimeout';
+
+export const setDocumentHidden = (hidden) => {
+  Object.defineProperty(document, 'hidden', {
+    configurable: true,
+    get: () => hidden,
+  });
+  document.dispatchEvent(new Event('visibilitychange'));
+};
+
+describe('focusTimeout', () => {
+  let clock;
+
+  beforeEach(() => {
+    clock = sinon.useFakeTimers();
+  });
+
+  afterEach(() => {
+    clock.restore();
+  })
+
+  it('should invoke callback when page is visible', () => {
+    let callback = sinon.stub();
+    setFocusTimeout(callback, 2000);
+    clock.tick(2000);
+    expect(callback.called).to.be.true;
+  });
+
+  it('should not invoke callback if page was hidden', () => {
+    let callback = sinon.stub();
+    setFocusTimeout(callback, 2000);
+    setDocumentHidden(true);
+    clock.tick(3000);
+    expect(callback.called).to.be.false;
+  });
+
+  it('should defer callback execution when page is hidden', () => {
+    let callback = sinon.stub();
+    setFocusTimeout(callback, 4000);
+    clock.tick(2000);
+    setDocumentHidden(true);
+    clock.tick(2000);
+    setDocumentHidden(false);
+    expect(callback.called).to.be.false;
+    clock.tick(2000);
+    expect(callback.called).to.be.true;
+  });
+
+  it('should return updated timerId after page was showed again', () => {
+    let callback = sinon.stub();
+    const getCurrentTimerId = setFocusTimeout(callback, 4000);
+    const oldTimerId = getCurrentTimerId();
+    clock.tick(2000);
+    setDocumentHidden(true);
+    clock.tick(2000);
+    setDocumentHidden(false);
+    const newTimerId = getCurrentTimerId();
+    expect(oldTimerId).to.not.equal(newTimerId);
+  });
+});

package/test/spec/videoCache_spec.js

@@ -1,39 +1,13 @@
 import chai from 'chai';
-import {getCacheUrl, store} from 'src/videoCache.js';
+import {batchingCache, getCacheUrl, store, _internal, storeBatch} from 'src/videoCache.js';
 import {config} from 'src/config.js';
 import {server} from 'test/mocks/xhr.js';
 import {auctionManager} from '../../src/auctionManager.js';
 import {AuctionIndex} from '../../src/auctionIndex.js';
-import {batchingCache} from '../../src/auction.js';
+import * as utils from 'src/utils.js';
 
 const should = chai.should();
 
-function getMockBid(bidder, auctionId, bidderRequestId) {
-  return {
-    'bidder': bidder,
-    'params': {
-      'placementId': '10433394',
-      'member': 123,
-      'keywords': {
-        'foo': ['bar', 'baz'],
-        'fizz': ['buzz']
-      }
-    },
-    'bid_id': '12345abc',
-    'adUnitCode': 'div-gpt-ad-1460505748561-0',
-    'mediaTypes': {
-      'banner': {
-        'sizes': [[300, 250]]
-      }
-    },
-    'transactionId': '4ef956ad-fd83-406d-bd35-e4bb786ab86c',
-    'sizes': [300, 250],
-    'bidId': '123',
-    'bidderRequestId': bidderRequestId,
-    'auctionId': auctionId
-  };
-}
-
 describe('The video cache', function () {
   function assertError(callbackSpy) {
     callbackSpy.calledOnce.should.equal(true);
@@ -126,9 +100,7 @@ describe('The video cache', function () {
     <Ad>
       <Wrapper>
         <AdSystem>prebid.org wrapper</AdSystem>
-        <VASTAdTagURI><![CDATA[my-mock-url.com]]></VASTAdTagURI>
-        
-        <Creatives></Creatives>
+        <VASTAdTagURI><![CDATA[my-mock-url.com]]></VASTAdTagURI>\n        \n        <Creatives></Creatives>
       </Wrapper>
     </Ad>
   </VAST>`;
@@ -335,34 +307,36 @@ describe('The video cache', function () {
       JSON.parse(request.requestBody).should.deep.equal(payload);
     });
 
-    it('should wait the duration of the batchTimeout and pass the correct batchSize if batched requests are enabled in the config', () => {
-      const mockAfterBidAdded = function() {};
-      let callback = null;
-      let mockTimeout = sinon.stub().callsFake((cb) => { callback = cb });
+    if (FEATURES.VIDEO) {
+      it('should wait the duration of the batchTimeout and pass the correct batchSize if batched requests are enabled in the config', () => {
+        const mockAfterBidAdded = function() {};
+        let callback = null;
+        let mockTimeout = sinon.stub().callsFake((cb) => { callback = cb });
 
-      config.setConfig({
-        cache: {
-          url: 'https://prebid.adnxs.com/pbc/v1/cache',
-          batchSize: 3,
-          batchTimeout: 20
-        }
-      });
+        config.setConfig({
+          cache: {
+            url: 'https://prebid.adnxs.com/pbc/v1/cache',
+            batchSize: 3,
+            batchTimeout: 20
+          }
+        });
 
-      let stubCache = sinon.stub();
-      const batchAndStore = batchingCache(mockTimeout, stubCache);
-      for (let i = 0; i < 3; i++) {
-        batchAndStore({}, {}, mockAfterBidAdded);
-      }
+        let stubCache = sinon.stub();
+        const batchAndStore = batchingCache(mockTimeout, stubCache);
+        for (let i = 0; i < 3; i++) {
+          batchAndStore({}, {}, mockAfterBidAdded);
+        }
 
-      sinon.assert.calledOnce(mockTimeout);
-      sinon.assert.calledWith(mockTimeout, sinon.match.any, 20);
+        sinon.assert.calledOnce(mockTimeout);
+        sinon.assert.calledWith(mockTimeout, sinon.match.any, 20);
 
-      const expectedBatch = [{ afterBidAdded: mockAfterBidAdded, auctionInstance: { }, bidResponse: { } }, { afterBidAdded: mockAfterBidAdded, auctionInstance: { }, bidResponse: { } }, { afterBidAdded: mockAfterBidAdded, auctionInstance: { }, bidResponse: { } }];
+        const expectedBatch = [{ afterBidAdded: mockAfterBidAdded, auctionInstance: { }, bidResponse: { } }, { afterBidAdded: mockAfterBidAdded, auctionInstance: { }, bidResponse: { } }, { afterBidAdded: mockAfterBidAdded, auctionInstance: { }, bidResponse: { } }];
 
-      callback();
+        callback();
 
-      sinon.assert.calledWith(stubCache, expectedBatch);
-    });
+        sinon.assert.calledWith(stubCache, expectedBatch);
+      });
+    }
 
     function assertRequestMade(bid, expectedValue) {
       store([bid], function () { });
@@ -393,6 +367,35 @@ describe('The video cache', function () {
       return callback;
     }
   });
+
+  describe('storeBatch', () => {
+    let sandbox;
+    let err, cacheIds
+    beforeEach(() => {
+      err = null;
+      cacheIds = [];
+      sandbox = sinon.createSandbox();
+      sandbox.stub(utils, 'logError');
+      sandbox.stub(_internal, 'store').callsFake((_, cb) => cb(err, cacheIds));
+    });
+    afterEach(() => {
+      sandbox.restore();
+    })
+    it('should log an error when store replies with an error', () => {
+      err = new Error('err');
+      storeBatch([]);
+      sinon.assert.called(utils.logError);
+    });
+    it('should not process returned uuids if they do not match the batch size', () => {
+      const el = {auctionInstance: {}, bidResponse: {}, afterBidAdded: sinon.stub()}
+      const batch = [el, el];
+      cacheIds = [{uuid: 'mock-id'}]
+      storeBatch(batch);
+      expect(el.bidResponse.videoCacheKey).to.not.exist;
+      sinon.assert.notCalled(batch[0].afterBidAdded);
+      sinon.assert.called(utils.logError);
+    })
+  })
 });
 
 describe('The getCache function', function () {