prebid.js 9.26.0 → 9.28.0

package/test/spec/modules/twistDigitalBidAdapter_spec.js

@@ -94,6 +94,36 @@ const VIDEO_BID = {
   }
 }
 
+const ORTB2_DEVICE = {
+  sua: {
+    'source': 2,
+    'platform': {
+      'brand': 'Android',
+      'version': ['8', '0', '0']
+    },
+    'browsers': [
+      {'brand': 'Not_A Brand', 'version': ['99', '0', '0', '0']},
+      {'brand': 'Google Chrome', 'version': ['109', '0', '5414', '119']},
+      {'brand': 'Chromium', 'version': ['109', '0', '5414', '119']}
+    ],
+    'mobile': 1,
+    'model': 'SM-G955U',
+    'bitness': '64',
+    'architecture': ''
+  },
+  w: 980,
+  h: 1720,
+  dnt: 0,
+  ua: 'Mozilla/5.0 (iPhone; CPU iPhone OS 17_4 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) CriOS/125.0.6422.80 Mobile/15E148 Safari/604.1',
+  language: 'en',
+  devicetype: 1,
+  make: 'Apple',
+  model: 'iPhone 12 Pro Max',
+  os: 'iOS',
+  osv: '17.4',
+  ext: {fiftyonedegrees_deviceId: '17595-133085-133468-18092'},
+};
+
 const BIDDER_REQUEST = {
   'gdprConsent': {
     'consentString': 'consent_string',
@@ -129,24 +159,7 @@ const BIDDER_REQUEST = {
       'gpp_sid': [7],
       'coppa': 0
     },
-    'device': {
-      'sua': {
-        'source': 2,
-        'platform': {
-          'brand': 'Android',
-          'version': ['8', '0', '0']
-        },
-        'browsers': [
-          {'brand': 'Not_A Brand', 'version': ['99', '0', '0', '0']},
-          {'brand': 'Google Chrome', 'version': ['109', '0', '5414', '119']},
-          {'brand': 'Chromium', 'version': ['109', '0', '5414', '119']}
-        ],
-        'mobile': 1,
-        'model': 'SM-G955U',
-        'bitness': '64',
-        'architecture': ''
-      }
-    },
+    device: ORTB2_DEVICE,
     user: {
       data: [
         {
@@ -341,6 +354,7 @@ describe('TwistDigitalBidAdapter', function () {
           },
           contentLang: 'en',
           coppa: 0,
+          device: ORTB2_DEVICE,
           contentData: [{
             'name': 'example.com',
             'ext': {
@@ -422,6 +436,7 @@ describe('TwistDigitalBidAdapter', function () {
             'bitness': '64',
             'architecture': ''
           },
+          device: ORTB2_DEVICE,
           url: 'https%3A%2F%2Fwww.greatsite.com',
           referrer: 'https://www.somereferrer.com',
           cb: 1000,
@@ -510,6 +525,7 @@ describe('TwistDigitalBidAdapter', function () {
           'bitness': '64',
           'architecture': ''
         },
+        device: ORTB2_DEVICE,
         url: 'https%3A%2F%2Fwww.greatsite.com',
         referrer: 'https://www.somereferrer.com',
         cb: 1000,

package/test/spec/modules/userId_spec.js

@@ -456,14 +456,54 @@ describe('User ID', function () {
             {'mockId2v1': {source: 'mock2source', atype: 2, getEidExt: () => ({v: 1})}}),
           createMockIdSubmodule('mockId2v2', null, null,
             {'mockId2v2': {source: 'mock2source', atype: 2, getEidExt: () => ({v: 2})}}),
+          createMockIdSubmodule('mockId2v3', null, null, {
+            'mockId2v3'(ids) {
+              return {
+                source: 'mock2source',
+                inserter: 'ins',
+                ext: {v: 2},
+                uids: ids.map(id => ({id, atype: 2}))
+              }
+            }
+          }),
+          createMockIdSubmodule('mockId2v4', null, null, {
+            'mockId2v4'(ids) {
+              return ids.map(id => ({
+                uids: [{id, atype: 0}],
+                source: 'mock2source',
+                inserter: 'ins',
+                ext: {v: 2}
+              }))
+            }
+          })
+        ]);
+      });
+
+      it('should filter out non-string uid returned by generator functions', () => {
+        const eids = createEidsArray({
+          mockId2v3: [null, 'id1', 123],
+        });
+        expect(eids[0].uids).to.eql([
+          {
+            atype: 2,
+            id: 'id1'
+          }
         ]);
       });
 
-      it('should group UIDs by source and ext', () => {
+      it('should filter out entire EID if none of the uids are strings', () => {
+        const eids = createEidsArray({
+          mockId2v3: [null],
+        });
+        expect(eids).to.eql([]);
+      })
+
+      it('should group UIDs by everything except uid', () => {
         const eids = createEidsArray({
           mockId1: ['mock-1-1', 'mock-1-2'],
           mockId2v1: ['mock-2-1', 'mock-2-2'],
-          mockId2v2: ['mock-2-1', 'mock-2-2']
+          mockId2v2: ['mock-2-1', 'mock-2-2'],
+          mockId2v3: ['mock-2-1', 'mock-2-2']
         });
         expect(eids).to.eql([
           {
@@ -510,10 +550,50 @@ describe('User ID', function () {
                 atype: 2,
               }
             ]
+          },
+          {
+            source: 'mock2source',
+            inserter: 'ins',
+            ext: {v: 2},
+            uids: [
+              {
+                id: 'mock-2-1',
+                atype: 2,
+              },
+              {
+                id: 'mock-2-2',
+                atype: 2,
+              }
+            ]
           }
         ])
       });
 
+      it('should group matching EIDs regardless of entry order', () => {
+        const eids = createEidsArray({
+          mockId2v3: ['id1', 'id2'],
+          mockId2v4: ['id3']
+        });
+        expect(eids).to.eql([{
+          source: 'mock2source',
+          inserter: 'ins',
+          uids: [
+            {
+              id: 'id1',
+              atype: 2,
+            },
+            {
+              id: 'id2',
+              atype: 2
+            },
+            {
+              id: 'id3',
+              atype: 0
+            }
+          ],
+          ext: {v: 2}
+        }])
+      })
       it('when merging with pubCommonId, should not alter its eids', () => {
         const uid = {
           pubProvidedId: [
@@ -705,6 +785,27 @@ describe('User ID', function () {
       });
     });
 
+    it('pbjs.getUserIdsAsEids should pass config to eid function', async function () {
+      const eidFn = sinon.stub();
+      init(config);
+      setSubmoduleRegistry([createMockIdSubmodule('mockId', null, null, {
+        mockId: eidFn
+      })]);
+      const moduleConfig = {
+        name: 'mockId',
+        value: {mockId: 'mockIdValue'},
+        some: 'config'
+      };
+      config.setConfig({
+        userSync: {
+          auctionDelay: 10,
+          userIds: [moduleConfig]
+        }
+      });
+      await getGlobal().getUserIdsAsync();
+      sinon.assert.calledWith(eidFn, ['mockIdValue'], moduleConfig);
+    })
+
     it('pbjs.getUserIdsAsEids should prioritize user ids according to config available to core', () => {
       init(config);
       setSubmoduleRegistry([

package/test/spec/modules/vidazooBidAdapter_spec.js

@@ -98,6 +98,36 @@ const VIDEO_BID = {
   }
 }
 
+const ORTB2_DEVICE = {
+  sua: {
+    'source': 2,
+    'platform': {
+      'brand': 'Android',
+      'version': ['8', '0', '0']
+    },
+    'browsers': [
+      {'brand': 'Not_A Brand', 'version': ['99', '0', '0', '0']},
+      {'brand': 'Google Chrome', 'version': ['109', '0', '5414', '119']},
+      {'brand': 'Chromium', 'version': ['109', '0', '5414', '119']}
+    ],
+    'mobile': 1,
+    'model': 'SM-G955U',
+    'bitness': '64',
+    'architecture': ''
+  },
+  w: 980,
+  h: 1720,
+  dnt: 0,
+  ua: 'Mozilla/5.0 (iPhone; CPU iPhone OS 17_4 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) CriOS/125.0.6422.80 Mobile/15E148 Safari/604.1',
+  language: 'en',
+  devicetype: 1,
+  make: 'Apple',
+  model: 'iPhone 12 Pro Max',
+  os: 'iOS',
+  osv: '17.4',
+  ext: {fiftyonedegrees_deviceId: '17595-133085-133468-18092'},
+};
+
 const BIDDER_REQUEST = {
   'gdprConsent': {
     'consentString': 'consent_string',
@@ -133,24 +163,7 @@ const BIDDER_REQUEST = {
       'gpp_sid': [7],
       'coppa': 0
     },
-    'device': {
-      'sua': {
-        'source': 2,
-        'platform': {
-          'brand': 'Android',
-          'version': ['8', '0', '0']
-        },
-        'browsers': [
-          {'brand': 'Not_A Brand', 'version': ['99', '0', '0', '0']},
-          {'brand': 'Google Chrome', 'version': ['109', '0', '5414', '119']},
-          {'brand': 'Chromium', 'version': ['109', '0', '5414', '119']}
-        ],
-        'mobile': 1,
-        'model': 'SM-G955U',
-        'bitness': '64',
-        'architecture': ''
-      }
-    },
+    device: ORTB2_DEVICE,
     user: {
       data: [
         {
@@ -346,6 +359,7 @@ describe('VidazooBidAdapter', function () {
           },
           contentLang: 'en',
           coppa: 0,
+          device: ORTB2_DEVICE,
           contentData: [{
             'name': 'example.com',
             'ext': {
@@ -430,6 +444,7 @@ describe('VidazooBidAdapter', function () {
             'bitness': '64',
             'architecture': ''
           },
+          device: ORTB2_DEVICE,
           url: 'https%3A%2F%2Fwww.greatsite.com',
           referrer: 'https://www.somereferrer.com',
           cb: 1000,
@@ -523,6 +538,7 @@ describe('VidazooBidAdapter', function () {
           'bitness': '64',
           'architecture': ''
         },
+        device: ORTB2_DEVICE,
         url: 'https%3A%2F%2Fwww.greatsite.com',
         referrer: 'https://www.somereferrer.com',
         cb: 1000,

package/test/spec/modules/videoModule/submodules/jwplayerVideoProvider_spec.js

@@ -26,6 +26,7 @@ function getPlayerMock() {
     getVolume: function () {},
     getConfig: function () {},
     getHeight: function () {},
+    getContainer: function () {},
     getWidth: function () {},
     getFullscreen: function () {},
     getPlaylistItem: function () {},
@@ -51,6 +52,9 @@ function makePlayerFactoryMock(playerMock_) {
 function getUtilsMock() {
   return {
     getJwConfig: function () {},
+    getPlayerHeight: function () {},
+    getPlayerWidth: function () {},
+    getPlayerSizeFromAspectRatio: function () {},
     getSupportedMediaTypes: function () {},
     getStartDelay: function () {},
     getPlacement: function () {},
@@ -212,6 +216,8 @@ describe('JWPlayerProvider', function () {
       player.getWidth = () => test_width;
       player.getFullscreen = () => true; //
 
+      utils.getPlayerHeight = () => 100;
+      utils.getPlayerWidth = () => 200;
       utils.getSupportedMediaTypes = () => [test_media_type];
       utils.getStartDelay = () => test_start_delay;
       utils.getPlacement = () => test_placement;
@@ -690,6 +696,81 @@ describe('utils', function () {
       expect(jwConfig.advertising).to.have.property('client', 'vast');
     });
   });
+
+  describe('getPlayerHeight', function () {
+    const getPlayerHeight = utils.getPlayerHeight;
+
+    it('should return height from API when defined', function () {
+      const expectedHeight = 500;
+      const playerMock = { getHeight: () => expectedHeight };
+      expect(getPlayerHeight(playerMock, {})).to.equal(expectedHeight);
+    });
+
+    it('should return height from config when API returns undefined', function () {
+      const expectedHeight = 500;
+      const playerMock = { getHeight: () => undefined };
+      expect(getPlayerHeight(playerMock, { height: 500 })).to.equal(expectedHeight);
+    });
+  });
+
+  describe('getPlayerWidth', function () {
+    const getPlayerWidth = utils.getPlayerWidth;
+
+    it('should return width from API when defined', function () {
+      const expectedWidth = 1000;
+      const playerMock = { getWidth: () => expectedWidth };
+      expect(getPlayerWidth(playerMock, {})).to.equal(expectedWidth);
+    });
+
+    it('should return width from config when API returns undefined', function () {
+      const expectedWidth = 1000;
+      const playerMock = { getWidth: () => undefined };
+      expect(getPlayerWidth(playerMock, { width: expectedWidth })).to.equal(expectedWidth);
+    });
+
+    it('should return undefined when width is string', function () {
+      const playerMock = { getWidth: () => undefined };
+      expect(getPlayerWidth(playerMock, { width: '50%' })).to.be.undefined;
+    });
+  });
+
+  describe('getPlayerSizeFromAspectRatio', function () {
+    const getPlayerSizeFromAspectRatio = utils.getPlayerSizeFromAspectRatio;
+    const testContainer = {
+      clientWidth: 640,
+      clientHeight: 480
+    };
+
+    it('should return an empty object when width and aspectratio are not strings', function () {
+      expect(getPlayerSizeFromAspectRatio({ getContainer: () => testContainer }, {})).to.deep.equal({});
+      expect(getPlayerSizeFromAspectRatio({ getContainer: () => testContainer }, {width: 100})).to.deep.equal({});
+      expect(getPlayerSizeFromAspectRatio({ getContainer: () => testContainer }, {aspectratio: '1:2', width: 100})).to.deep.equal({});
+    });
+
+    it('should return an empty object when aspectratio is malformed', function () {
+      expect(getPlayerSizeFromAspectRatio({ getContainer: () => testContainer }, {aspectratio: '0.5', width: '100%'})).to.deep.equal({});
+      expect(getPlayerSizeFromAspectRatio({ getContainer: () => testContainer }, {aspectratio: '1-2', width: '100%'})).to.deep.equal({});
+      expect(getPlayerSizeFromAspectRatio({ getContainer: () => testContainer }, {aspectratio: '1:', width: '100%'})).to.deep.equal({});
+      expect(getPlayerSizeFromAspectRatio({ getContainer: () => testContainer }, {aspectratio: ':2', width: '100%'})).to.deep.equal({});
+      expect(getPlayerSizeFromAspectRatio({ getContainer: () => testContainer }, {aspectratio: ':', width: '100%'})).to.deep.equal({});
+      expect(getPlayerSizeFromAspectRatio({ getContainer: () => testContainer }, {aspectratio: '1:2:3', width: '100%'})).to.deep.equal({});
+    });
+
+    it('should return an empty object when player container cannot be obtained', function () {
+      expect(getPlayerSizeFromAspectRatio({}, {aspectratio: '1:2', width: '100%'})).to.deep.equal({});
+      expect(getPlayerSizeFromAspectRatio({ getContainer: () => undefined }, {aspectratio: '1:2', width: '100%'})).to.deep.equal({});
+    });
+
+    it('should calculate the size given the width percentage and aspect ratio', function () {
+      expect(getPlayerSizeFromAspectRatio({ getContainer: () => testContainer }, {aspectratio: '2:1', width: '100%'})).to.deep.equal({ height: 320, width: 640 });
+      expect(getPlayerSizeFromAspectRatio({ getContainer: () => testContainer }, {aspectratio: '4:1', width: '70%'})).to.deep.equal({ height: 112, width: 448 });
+    });
+
+    it('should return the container height when smaller than the calculated height', function () {
+      expect(getPlayerSizeFromAspectRatio({ getContainer: () => testContainer }, {aspectratio: '1:1', width: '100%'})).to.deep.equal({ height: 480, width: 640 });
+    });
+  });
+
   describe('getSkipParams', function () {
     const getSkipParams = utils.getSkipParams;
 

package/test/spec/modules/wurflRtdProvider_spec.js

@@ -52,7 +52,8 @@ describe('wurflRtdProvider', function () {
       pixel_density: 443,
       pointing_method: 'touchscreen',
       resolution_height: 1920,
-      resolution_width: 1080
+      resolution_width: 1080,
+      wurfl_id: 'lg_nexus5_ver1',
     };
 
     // expected analytics values
@@ -100,6 +101,7 @@ describe('wurflRtdProvider', function () {
       const expectedURL = new URL(altHost);
       expectedURL.searchParams.set('debug', true);
       expectedURL.searchParams.set('mode', 'prebid');
+      expectedURL.searchParams.set('wurfl_id', true);
 
       const callback = () => {
         const v = {
@@ -147,7 +149,8 @@ describe('wurflRtdProvider', function () {
                   pixel_density: 443,
                   pointing_method: 'touchscreen',
                   resolution_height: 1920,
-                  resolution_width: 1080
+                  resolution_width: 1080,
+                  wurfl_id: 'lg_nexus5_ver1',
                 },
               },
             },
@@ -187,7 +190,8 @@ describe('wurflRtdProvider', function () {
                   model_name: 'Nexus 5',
                   pixel_density: 443,
                   resolution_height: 1920,
-                  resolution_width: 1080
+                  resolution_width: 1080,
+                  wurfl_id: 'lg_nexus5_ver1',
                 },
               },
             },
@@ -203,6 +207,7 @@ describe('wurflRtdProvider', function () {
                   is_mobile: !0,
                   model_name: 'Nexus 5',
                   brand_name: 'Google',
+                  wurfl_id: 'lg_nexus5_ver1',
                 },
               },
             },

package/test/spec/modules/yieldlabBidAdapter_spec.js

@@ -263,7 +263,7 @@ const REQPARAMS = {
 
 const REQPARAMS_GDPR = Object.assign({}, REQPARAMS, {
   gdpr: true,
-  consent: 'BN5lERiOMYEdiAKAWXEND1AAAAE6DABACMA',
+  gdpr_consent: 'BN5lERiOMYEdiAKAWXEND1AAAAE6DABACMA',
 });
 
 const REQPARAMS_IAB_CONTENT = Object.assign({}, REQPARAMS, {
@@ -457,8 +457,8 @@ describe('yieldlabBidAdapter', () => {
         },
       });
 
-      expect(gdprRequest.url).to.include('consent=BN5lERiOMYEdiAKAWXEND1AAAAE6DABACMA');
-      expect(gdprRequest.url).to.include('gdpr=true');
+      expect(gdprRequest.url).to.include('&gdpr_consent=BN5lERiOMYEdiAKAWXEND1AAAAE6DABACMA');
+      expect(gdprRequest.url).to.include('&gdpr=true');
     });
 
     describe('sizes handling', () => {
@@ -691,7 +691,7 @@ describe('yieldlabBidAdapter', () => {
       const result = spec.interpretResponse({body: [RESPONSE]}, {validBidRequests: [bidRequest], queryParams: REQPARAMS_GDPR});
 
       expect(result[0].ad).to.include('&gdpr=true');
-      expect(result[0].ad).to.include('&consent=BN5lERiOMYEdiAKAWXEND1AAAAE6DABACMA');
+      expect(result[0].ad).to.include('&gdpr_consent=BN5lERiOMYEdiAKAWXEND1AAAAE6DABACMA');
     });
 
     it('should append iab_content to adtag', () => {
@@ -814,7 +814,7 @@ describe('yieldlabBidAdapter', () => {
       const result = spec.interpretResponse({body: [VIDEO_RESPONSE]}, {validBidRequests: [VIDEO_REQUEST()], queryParams: REQPARAMS_GDPR});
 
       expect(result[0].vastUrl).to.include('&gdpr=true');
-      expect(result[0].vastUrl).to.include('&consent=BN5lERiOMYEdiAKAWXEND1AAAAE6DABACMA');
+      expect(result[0].vastUrl).to.include('&gdpr_consent=BN5lERiOMYEdiAKAWXEND1AAAAE6DABACMA');
     });
 
     it('should add renderer if outstream context', () => {

package/test/spec/modules/zeta_global_sspAnalyticsAdapter_spec.js

@@ -529,6 +529,7 @@ describe('Zeta Global SSP Analytics Adapter', function () {
     sandbox = sinon.sandbox.create();
     requests = server.requests;
     sandbox.stub(events, 'getEvents').returns([]);
+    config.setConfig({ pageUrl: 'https://www.config.domain.com/index.html' })
   });
 
   afterEach(function () {
@@ -624,8 +625,8 @@ describe('Zeta Global SSP Analytics Adapter', function () {
           shortname: 'name'
         }
       });
-      expect(auctionSucceeded.domain).to.eql('test-zeta-ssp.net');
-      expect(auctionSucceeded.page).to.eql('test-zeta-ssp.net/zeta-ssp/ssp/_dev/examples/page_banner.html');
+      expect(auctionSucceeded.domain).to.eql('config.domain.com');
+      expect(auctionSucceeded.page).to.eql('https://www.config.domain.com/index.html');
       expect(auctionSucceeded.bid).to.be.deep.equal({
         adUnitCode: '/19968336/header-bid-tag-0',
         adId: '5759bb3ef7be1e8',

package/test/spec/native_spec.js

@@ -402,7 +402,8 @@ describe('native.js', function () {
       'returns native data': {
         renderDataHook(next, bidResponse) {
           next.bail({
-            native: getNativeRenderingData(bidResponse, adUnit)
+            native: getNativeRenderingData(bidResponse, adUnit),
+            rendererVersion: 'native-render-version'
           });
         },
         renderSourceHook(next) {
@@ -433,8 +434,9 @@ describe('native.js', function () {
         function checkRenderer(message) {
           if (withRenderer) {
             expect(message.renderer).to.eql('mock-native-renderer')
+            expect(message.rendererVersion).to.eql('native-render-version');
             Object.entries(message).forEach(([key, val]) => {
-              if (!['native', 'adId', 'message', 'assets', 'renderer'].includes(key)) {
+              if (!['native', 'adId', 'message', 'assets', 'renderer', 'rendererVersion'].includes(key)) {
                 expect(message.native[key]).to.eql(val);
               }
             })