prebid.js 9.1.0 → 9.3.0

package/test/spec/modules/setupadBidAdapter_spec.js

@@ -1,4 +1,4 @@
-import { spec } from 'modules/setupadBidAdapter.js';
+import { spec, biddersCreativeIds } from 'modules/setupadBidAdapter.js';
 
 describe('SetupadAdapter', function () {
   const userIdAsEids = [
@@ -42,9 +42,104 @@ describe('SetupadAdapter', function () {
       },
       userIdAsEids,
     },
+    {
+      adUnitCode: 'test-div-2',
+      auctionId: 'b06c5141-fe8f-4cdf-9d7d-54415490a917',
+      bidId: '22c4871113f461',
+      bidder: 'rubicon',
+      bidderRequestId: '15246a574e859f',
+      uspConsent: 'usp-context-string',
+      gdprConsent: {
+        consentString: 'BOtmiBKOtmiBKABABAENAFAAAAACeAAA',
+        gdprApplies: true,
+      },
+      params: {
+        placement_id: '123',
+        account_id: 'test-account-id',
+      },
+      sizes: [[300, 250]],
+      ortb2: {
+        device: {
+          w: 1500,
+          h: 1000,
+        },
+        site: {
+          domain: 'test.com',
+          page: 'http://test.com',
+        },
+      },
+      userIdAsEids,
+    },
   ];
 
   const bidderRequest = {
+    auctionId: 'b06c5141-fe8f-4cdf-9d7d-54415490a917',
+    auctionStart: 1579746300522,
+    bidderCode: 'setupad',
+    bidderRequestId: '15246a574e859f',
+    bids: [
+      {
+        adUnitCode: 'test-div',
+        auctionId: 'b06c5141-fe8f-4cdf-9d7d-54415490a917',
+        bidId: '22c4871113f461',
+        bidder: 'rubicon',
+        bidderRequestId: '15246a574e859f',
+        uspConsent: 'usp-context-string',
+        gdprConsent: {
+          consentString: 'BOtmiBKOtmiBKABABAENAFAAAAACeAAA',
+          gdprApplies: true,
+        },
+        params: {
+          placement_id: '123',
+          account_id: 'test-account-id',
+        },
+        sizes: [[300, 250]],
+        ortb2: {
+          device: {
+            w: 1500,
+            h: 1000,
+          },
+          site: {
+            domain: 'test.com',
+            page: 'http://test.com',
+          },
+        },
+        userIdAsEids,
+      },
+      {
+        adUnitCode: 'test-div-2',
+        auctionId: 'b06c5141-fe8f-4cdf-9d7d-54415490a917',
+        bidId: '22c4871113f461',
+        bidder: 'rubicon',
+        bidderRequestId: '15246a574e859f',
+        uspConsent: 'usp-context-string',
+        gdprConsent: {
+          consentString: 'BOtmiBKOtmiBKABABAENAFAAAAACeAAA',
+          gdprApplies: true,
+        },
+        params: {
+          placement_id: '123',
+          account_id: 'test-account-id',
+        },
+        sizes: [[300, 250]],
+        ortb2: {
+          device: {
+            w: 1500,
+            h: 1000,
+          },
+          site: {
+            domain: 'test.com',
+            page: 'http://test.com',
+          },
+        },
+        userIdAsEids,
+      },
+    ],
+    gdprConsent: {
+      consentString: 'BOtmiBKOtmiBKABABAENAFAAAAACeAAA',
+      vendorData: {},
+      gdprApplies: true,
+    },
     ortb2: {
       device: {
         w: 1500,
@@ -52,39 +147,27 @@ describe('SetupadAdapter', function () {
       },
     },
     refererInfo: {
+      canonicalUrl: null,
       domain: 'test.com',
       page: 'http://test.com',
-      ref: '',
+      referer: null,
     },
   };
 
   const serverResponse = {
     body: {
-      id: 'f7b3d2da-e762-410c-b069-424f92c4c4b2',
       seatbid: [
         {
-          bid: [
-            {
-              id: 'test-bid-id',
-              price: 0.8,
-              adm: 'this is an ad',
-              adid: 'test-ad-id',
-              adomain: ['test.addomain.com'],
-              w: 300,
-              h: 250,
-            },
-          ],
-          seat: 'testBidder',
+          bid: [{ crid: 123 }, { crid: 1234 }],
+          seat: 'pubmatic',
         },
-      ],
-      cur: 'USD',
-      ext: {
-        sync: {
-          image: ['urlA?gdpr={{.GDPR}}'],
-          iframe: ['urlB'],
+        {
+          bid: [{ crid: 12345 }],
+          seat: 'setupad',
         },
-      },
+      ],
     },
+    testCase: 1,
   };
 
   describe('isBidRequestValid', function () {
@@ -119,77 +202,25 @@ describe('SetupadAdapter', function () {
   });
 
   describe('buildRequests', function () {
-    it('check request params with GDPR and USP', function () {
-      const request = spec.buildRequests(bidRequests, bidRequests[0]);
-      expect(JSON.parse(request[0].data).user.ext.consent).to.equal(
-        'BOtmiBKOtmiBKABABAENAFAAAAACeAAA'
-      );
-      expect(JSON.parse(request[0].data).regs.ext.gdpr).to.equal(1);
-      expect(JSON.parse(request[0].data).regs.ext.us_privacy).to.equal('usp-context-string');
-    });
-
-    it('check request params without GDPR', function () {
-      let bidRequestsWithoutGDPR = Object.assign({}, bidRequests[0]);
-      delete bidRequestsWithoutGDPR.gdprConsent;
-      const request = spec.buildRequests([bidRequestsWithoutGDPR], bidRequestsWithoutGDPR);
-      expect(JSON.parse(request[0].data).regs.ext.gdpr).to.be.undefined;
-      expect(JSON.parse(request[0].data).regs.ext.us_privacy).to.equal('usp-context-string');
+    it('should return correct storedrequest id for bids if placement_id is provided', function () {
+      const request = spec.buildRequests(bidRequests, bidderRequest);
+      expect(request.data.imp[0].ext.prebid.storedrequest.id).to.equal('123');
     });
 
     it('should return correct storedrequest id if account_id is provided', function () {
-      const request = spec.buildRequests(bidRequests, bidRequests[0]);
-      expect(JSON.parse(request[0].data).ext.prebid.storedrequest.id).to.equal('test-account-id');
-    });
-
-    it('should return correct storedrequest id if account_id is not provided', function () {
-      let bidRequestsWithoutAccountId = Object.assign({}, bidRequests[0]);
-      delete bidRequestsWithoutAccountId.params.account_id;
-      const request = spec.buildRequests(
-        [bidRequestsWithoutAccountId],
-        bidRequestsWithoutAccountId
-      );
-      expect(JSON.parse(request[0].data).ext.prebid.storedrequest.id).to.equal('default');
-    });
-
-    it('validate generated params', function () {
-      const request = spec.buildRequests(bidRequests);
-      expect(request[0].bidId).to.equal('22c4871113f461');
-      expect(JSON.parse(request[0].data).id).to.equal('15246a574e859f');
-    });
-
-    it('check if correct site object was added', function () {
       const request = spec.buildRequests(bidRequests, bidderRequest);
-      const siteObj = JSON.parse(request[0].data).site;
-
-      expect(siteObj.domain).to.equal('test.com');
-      expect(siteObj.page).to.equal('http://test.com');
-      expect(siteObj.ref).to.equal('');
+      expect(request.data.ext.prebid.storedrequest.id).to.equal('test-account-id');
     });
 
-    it('check if correct device object was added', function () {
+    it('should return setupad custom adapter param', function () {
       const request = spec.buildRequests(bidRequests, bidderRequest);
-      const deviceObj = JSON.parse(request[0].data).device;
-
-      expect(deviceObj.w).to.equal(1500);
-      expect(deviceObj.h).to.equal(1000);
-    });
-
-    it('check if imp object was added', function () {
-      const request = spec.buildRequests(bidRequests);
-      expect(JSON.parse(request[0].data).imp).to.be.an('array');
-    });
-
-    it('should send "user.ext.eids" in the request for Prebid.js supported modules only', function () {
-      const request = spec.buildRequests(bidRequests);
-      expect(JSON.parse(request[0].data).user.ext.eids).to.deep.equal(userIdAsEids);
+      expect(request.data.setupad).to.equal('adapter');
     });
 
-    it('should send an undefined "user.ext.eids" in the request if userId module is unsupported', function () {
-      let bidRequestsUnsupportedUserIdModule = Object.assign({}, bidRequests[0]);
-      delete bidRequestsUnsupportedUserIdModule.userIdAsEids;
-      const request = spec.buildRequests(bidRequestsUnsupportedUserIdModule);
-
-      expect(JSON.parse(request[0].data).user.ext.eids).to.be.undefined;
+    // Change this to 1 whenever TEST_REQUEST = 1. This is allowed only for testing requests locally
+    it('should return correct test attribute value from global value', function () {
+      const request = spec.buildRequests(bidRequests, bidderRequest);
+      expect(request.data.test).to.equal(0);
     });
   });
 
@@ -256,25 +287,21 @@ describe('SetupadAdapter', function () {
   describe('interpretResponse', function () {
     it('should return empty array if error during parsing', () => {
       const wrongServerResponse = 'wrong data';
-      let request = spec.buildRequests(bidRequests, bidRequests[0]);
+      let request = spec.buildRequests(bidRequests, bidderRequest);
       let result = spec.interpretResponse(wrongServerResponse, request);
 
       expect(result).to.be.instanceof(Array);
       expect(result.length).to.equal(0);
     });
 
-    it('should get correct bid response', function () {
-      const result = spec.interpretResponse(serverResponse, bidRequests[0]);
-      expect(result).to.be.an('array').with.lengthOf(1);
-      expect(result[0].requestId).to.equal('22c4871113f461');
-      expect(result[0].cpm).to.equal(0.8);
-      expect(result[0].width).to.equal(300);
-      expect(result[0].height).to.equal(250);
-      expect(result[0].creativeId).to.equal('test-bid-id');
-      expect(result[0].currency).to.equal('USD');
-      expect(result[0].netRevenue).to.equal(true);
-      expect(result[0].ttl).to.equal(360);
-      expect(result[0].ad).to.equal('this is an ad');
+    it('should update biddersCreativeIds correctly', function () {
+      spec.interpretResponse(serverResponse, bidderRequest);
+
+      expect(biddersCreativeIds).to.deep.equal({
+        123: 'pubmatic',
+        1234: 'pubmatic',
+        12345: 'setupad',
+      });
     });
   });
 

package/test/spec/modules/smartadserverBidAdapter_spec.js

@@ -458,6 +458,13 @@ describe('Smart bid adapter tests', function () {
     expect(syncs).to.have.lengthOf(0);
   });
 
+  it('should set browsingTopics=false in request.options', () => {
+    const requests = spec.buildRequests(DEFAULT_PARAMS_WO_OPTIONAL);
+    expect(requests[0]).to.have.property('options').and.to.deep.equal({
+      browsingTopics: false
+    });
+  });
+
   describe('gdpr tests', function () {
     afterEach(function () {
       config.setConfig({ ortb2: undefined });

package/test/spec/modules/smartyadsBidAdapter_spec.js

@@ -61,12 +61,10 @@ describe('SmartyadsAdapter', function () {
     it('Returns valid data if array of bids is valid', function () {
       let data = serverRequest.data;
       expect(data).to.be.an('object');
-      expect(data).to.have.all.keys('deviceWidth', 'deviceHeight', 'language', 'secure', 'host', 'page', 'placements', 'coppa', 'eeid', 'ifa');
+      expect(data).to.have.all.keys('deviceWidth', 'deviceHeight', 'host', 'page', 'placements', 'coppa', 'eeid', 'ifa');
       expect(data.deviceWidth).to.be.a('number');
       expect(data.deviceHeight).to.be.a('number');
       expect(data.coppa).to.be.a('number');
-      expect(data.language).to.be.a('string');
-      expect(data.secure).to.be.within(0, 1);
       expect(data.host).to.be.a('string');
       expect(data.page).to.be.a('string');
       let placement = data['placements'][0];
@@ -126,8 +124,8 @@ describe('SmartyadsAdapter', function () {
       expect(dataItem.width).to.equal(300);
       expect(dataItem.height).to.equal(250);
       expect(dataItem.ad).to.equal('Test');
-      expect(dataItem.meta).to.have.property('advertiserDomains')
-      expect(dataItem.meta.advertiserDomains).to.deep.equal(['example.com']);
+      expect(dataItem.meta).to.have.property('advertiserDomains');
+      expect(dataItem.meta.advertiserDomains).to.be.an('array');
       expect(dataItem.ttl).to.equal(120);
       expect(dataItem.creativeId).to.equal('2');
       expect(dataItem.netRevenue).to.be.true;
@@ -152,7 +150,7 @@ describe('SmartyadsAdapter', function () {
 
       let dataItem = videoResponses[0];
       expect(dataItem).to.have.all.keys('requestId', 'cpm', 'vastUrl', 'ttl', 'creativeId',
-        'netRevenue', 'currency', 'dealId', 'mediaType');
+        'netRevenue', 'currency', 'dealId', 'mediaType', 'meta');
       expect(dataItem.requestId).to.equal('23fhj33i987f');
       expect(dataItem.cpm).to.equal(0.5);
       expect(dataItem.vastUrl).to.equal('test.com');
@@ -183,7 +181,7 @@ describe('SmartyadsAdapter', function () {
       expect(nativeResponses).to.be.an('array').that.is.not.empty;
 
       let dataItem = nativeResponses[0];
-      expect(dataItem).to.have.keys('requestId', 'cpm', 'ttl', 'creativeId', 'netRevenue', 'currency', 'mediaType', 'native');
+      expect(dataItem).to.have.keys('requestId', 'cpm', 'ttl', 'creativeId', 'netRevenue', 'currency', 'mediaType', 'native', 'meta');
       expect(dataItem.native).to.have.keys('clickUrl', 'impressionTrackers', 'title', 'image')
       expect(dataItem.requestId).to.equal('23fhj33i987f');
       expect(dataItem.cpm).to.equal(0.4);
@@ -263,7 +261,7 @@ describe('SmartyadsAdapter', function () {
     });
   });
   describe('getUserSyncs', function () {
-    const syncUrl = 'https://as.ck-ie.com/prebidjs?p=7c47322e527cf8bdeb7facc1bb03387a&gdpr=0&gdpr_consent=&type=iframe&us_privacy=&gpp=';
+    const syncUrl = 'https://as.ck-ie.com/prebidjs?p=7c47322e527cf8bdeb7facc1bb03387a/iframe?pbjs=1&coppa=0';
     const syncOptions = {
       iframeEnabled: true
     };
@@ -277,79 +275,4 @@ describe('SmartyadsAdapter', function () {
       ]);
     });
   });
-
-  describe('onBidWon', function () {
-    it('should exists', function () {
-      expect(spec.onBidWon).to.exist.and.to.be.a('function');
-    });
-
-    it('should send a valid bid won notice', function () {
-      const bid = {
-        'c': 'o',
-        'm': 'prebid',
-        'secret_key': 'prebid_js',
-        'winTest': '1',
-        'postData': [{
-          'bidder': 'smartyads',
-          'params': [
-            {'host': 'prebid',
-              'accountid': '123',
-              'sourceid': '12345'
-            }]
-        }]
-      };
-      spec.onBidWon(bid);
-      expect(server.requests.length).to.equal(1);
-    });
-  });
-
-  describe('onTimeout', function () {
-    it('should exists', function () {
-      expect(spec.onTimeout).to.exist.and.to.be.a('function');
-    });
-
-    it('should send a valid bid timeout notice', function () {
-      const bid = {
-        'c': 'o',
-        'm': 'prebid',
-        'secret_key': 'prebid_js',
-        'bidTimeout': '1',
-        'postData': [{
-          'bidder': 'smartyads',
-          'params': [
-            {'host': 'prebid',
-              'accountid': '123',
-              'sourceid': '12345'
-            }]
-        }]
-      };
-      spec.onTimeout(bid);
-      expect(server.requests.length).to.equal(1);
-    });
-  });
-
-  describe('onBidderError', function () {
-    it('should exists', function () {
-      expect(spec.onBidderError).to.exist.and.to.be.a('function');
-    });
-
-    it('should send a valid bidder error notice', function () {
-      const bid = {
-        'c': 'o',
-        'm': 'prebid',
-        'secret_key': 'prebid_js',
-        'bidderError': '1',
-        'postData': [{
-          'bidder': 'smartyads',
-          'params': [
-            {'host': 'prebid',
-              'accountid': '123',
-              'sourceid': '12345'
-            }]
-        }]
-      };
-      spec.onBidderError(bid);
-      expect(server.requests.length).to.equal(1);
-    });
-  });
 });

package/test/spec/modules/smartytechBidAdapter_spec.js

@@ -204,7 +204,11 @@ function mockResponseData(requestData) {
       creativeId: `creative-id-${index}`,
       cpm: Math.floor(Math.random() * 100),
       currency: `UAH-${rndIndex}`,
-      mediaType: mediaType
+      mediaType: mediaType,
+      meta: {
+        primaryCatId: 'IAB2-2',
+        secondaryCatIds: ['IAB2-14', 'IAB2-6']
+      }
     };
   });
   return {

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/twistDigitalBidAdapter_spec.js

@@ -3,9 +3,6 @@ import {
   spec as adapter,
   createDomain,
   hashCode,
-  extractPID,
-  extractCID,
-  extractSubDomain,
   getStorageItem,
   setStorageItem,
   tryParseJSON,
@@ -18,6 +15,11 @@ import {useFakeTimers} from 'sinon';
 import {BANNER, VIDEO} from '../../../src/mediaTypes';
 import {config} from '../../../src/config';
 import {deepSetValue} from 'src/utils.js';
+import {
+  extractPID,
+  extractCID,
+  extractSubDomain
+} from '../../../libraries/vidazooUtils/bidderUtils.js';
 
 export const TEST_ID_SYSTEMS = ['britepoolid', 'criteoId', 'id5id', 'idl_env', 'lipb', 'netId', 'parrableId', 'pubcid', 'tdid', 'pubProvidedId'];