prebid.js 6.22.0 → 6.23.0

package/test/spec/modules/asealBidAdapter_spec.js

@@ -1,120 +1,187 @@
 import { expect } from 'chai';
-import { spec, BIDDER_CODE, API_ENDPOINT, HEADER_AOTTER_VERSION } from 'modules/asealBidAdapter.js';
+import {
+  spec,
+  BIDDER_CODE,
+  API_ENDPOINT,
+  HEADER_AOTTER_VERSION,
+  WEB_SESSION_ID_KEY,
+} from 'modules/asealBidAdapter.js';
+import { getRefererInfo } from 'src/refererDetection.js';
 import { newBidder } from 'src/adapters/bidderFactory.js';
 import { config } from 'src/config.js';
+import * as utils from 'src/utils.js';
+import { storage } from 'modules/asealBidAdapter.js';
 
-const TEST_CLIENT_ID = 'TEST_CLIENT_ID'
+const TEST_CLIENT_ID = 'TEST_CLIENT_ID';
+const TEST_WEB_SESSION_ID = 'TEST_WEB_SESSION_ID';
 
 describe('asealBidAdapter', () => {
   const adapter = newBidder(spec);
 
+  let localStorageIsEnabledStub;
+  let getDataFromLocalStorageStub;
+  let sandbox;
+  let w;
+
+  beforeEach((done) => {
+    localStorageIsEnabledStub = sinon.stub(storage, 'localStorageIsEnabled');
+    getDataFromLocalStorageStub = sinon.stub(
+      storage,
+      'getDataFromLocalStorage'
+    );
+
+    w = {
+      document: {
+        title: 'Aseal',
+        referrer: 'https://aseal.in/',
+        href: 'https://aseal.in/',
+      },
+      location: {
+        href: 'https://aseal.in/',
+      },
+    };
+
+    sandbox = sinon.sandbox.create();
+    sandbox.stub(utils, 'getWindowTop').returns(w);
+    sandbox.stub(utils, 'getWindowSelf').returns(w);
+    done();
+  });
+
+  afterEach(() => {
+    localStorageIsEnabledStub.restore();
+    getDataFromLocalStorageStub.restore();
+    sandbox.restore();
+    config.resetConfig();
+  });
+
   describe('inherited functions', () => {
     it('exists and is a function', () => {
-      expect(adapter.callBids).to.exist.and.to.be.a('function')
-    })
+      expect(adapter.callBids).to.exist.and.to.be.a('function');
+    });
   });
 
   describe('isBidRequestValid', () => {
     const bid = {
       bidder: 'aseal',
       params: {
-        placeUid: '123'
-      }
+        placeUid: '123',
+      },
     };
 
     it('should return true when required params found', () => {
-      expect(spec.isBidRequestValid(bid)).to.equal(true)
+      expect(spec.isBidRequestValid(bid)).to.equal(true);
     });
 
     it('should return false when required param placeUid is not passed', () => {
       bid.params = {
-        placeUid: ''
-      }
-      expect(spec.isBidRequestValid(bid)).to.equal(false)
+        placeUid: '',
+      };
+      expect(spec.isBidRequestValid(bid)).to.equal(false);
     });
 
     it('should return false when required param placeUid is wrong type', () => {
       bid.params = {
-        placeUid: null
-      }
-      expect(spec.isBidRequestValid(bid)).to.equal(false)
+        placeUid: null,
+      };
+      expect(spec.isBidRequestValid(bid)).to.equal(false);
     });
 
     it('should return false when required params are not passed', () => {
       let bid = Object.assign({}, bid);
       delete bid.params;
       bid.params = {};
-      expect(spec.isBidRequestValid(bid)).to.equal(false)
-    })
+      expect(spec.isBidRequestValid(bid)).to.equal(false);
+    });
   });
 
   describe('buildRequests', () => {
-    afterEach(() => {
-      config.resetConfig();
-    });
-
     it('should return an empty array when there are no bid requests', () => {
-      const bidRequests = []
-      const request = spec.buildRequests(bidRequests)
+      const bidRequests = [];
+      const request = spec.buildRequests(bidRequests);
 
-      expect(request).to.be.an('array').that.is.empty
+      expect(request).to.be.an('array').that.is.empty;
     });
 
     it('should send `x-aotter-clientid` header as empty string when user not set config `clientId`', () => {
-      const bidRequests = [{
-        bidder: BIDDER_CODE,
-        params: {
-          placeUid: '123'
-        }
-      }]
-
-      const bidderRequest = {}
+      const bidRequests = [
+        {
+          bidder: BIDDER_CODE,
+          params: {
+            placeUid: '123',
+          },
+        },
+      ];
+
+      const bidderRequest = {};
       const request = spec.buildRequests(bidRequests, bidderRequest)[0];
 
-      expect(request.options.customHeaders['x-aotter-clientid']).equal('')
-    })
+      expect(request.options.customHeaders['x-aotter-clientid']).equal('');
+    });
 
     it('should send bid requests to ENDPOINT via POST', () => {
-      const bidRequests = [{
-        bidder: BIDDER_CODE,
-        params: {
-          placeUid: '123'
-        }
-      }]
+      const bidRequests = [
+        {
+          bidder: BIDDER_CODE,
+          params: {
+            placeUid: '123',
+          },
+        },
+      ];
 
       const bidderRequest = {
-        refererInfo: {
-          referer: 'https://aseal.in/',
-        }
-      }
+        refererInfo: getRefererInfo(),
+      };
 
       config.setConfig({
         aseal: {
-          clientId: TEST_CLIENT_ID
-        }
+          clientId: TEST_CLIENT_ID,
+        },
       });
+
+      localStorageIsEnabledStub.returns(true);
+      getDataFromLocalStorageStub
+        .withArgs(WEB_SESSION_ID_KEY)
+        .returns(TEST_WEB_SESSION_ID);
+
       const request = spec.buildRequests(bidRequests, bidderRequest)[0];
 
+      utils.getWindowTop.restore();
+      utils.getWindowSelf.restore();
+
+      sandbox.stub(utils, 'getWindowTop').returns(w);
+      sandbox.stub(utils, 'getWindowSelf').returns(w);
+
+      const payload = {
+        meta: {
+          dr: w.document.referrer,
+          drs: w.document.referrer,
+          drt: w.document.referrer,
+          dt: w.document.title,
+          dl: w.location.href,
+        },
+      };
+
       expect(request.url).to.equal(API_ENDPOINT);
-      expect(request.method).to.equal('POST')
+      expect(request.method).to.equal('POST');
       expect(request.options).deep.equal({
         contentType: 'application/json',
         withCredentials: true,
         customHeaders: {
           'x-aotter-clientid': TEST_CLIENT_ID,
           'x-aotter-version': HEADER_AOTTER_VERSION,
-        }
+        },
       });
-      expect(request.data).deep.equal({
-        bids: bidRequests,
-        refererInfo: bidderRequest.refererInfo,
+      expect(request.data.bids).deep.equal(bidRequests);
+      expect(request.data.payload).deep.equal(payload);
+      expect(request.data.device).deep.equal({
+        webSessionId: TEST_WEB_SESSION_ID,
       });
     });
   });
 
   describe('interpretResponse', () => {
     it('should return an empty array when there are no bids', () => {
-      const serverResponse = {}
+      const serverResponse = {};
       const response = spec.interpretResponse(serverResponse);
 
       expect(response).is.an('array').that.is.empty;
@@ -122,23 +189,25 @@ describe('asealBidAdapter', () => {
 
     it('should get correct bid response', () => {
       const serverResponse = {
-        body: [{
-          requestId: '2ef08f145b7a4f',
-          cpm: 3,
-          width: 300,
-          height: 250,
-          creativeId: '123abc',
-          dealId: '123abc',
-          currency: 'USD',
-          netRevenue: false,
-          mediaType: 'banner',
-          ttl: 300,
-          ad: '<!-- adtag -->'
-        }]
-      }
+        body: [
+          {
+            requestId: '2ef08f145b7a4f',
+            cpm: 3,
+            width: 300,
+            height: 250,
+            creativeId: '123abc',
+            dealId: '123abc',
+            currency: 'USD',
+            netRevenue: false,
+            mediaType: 'banner',
+            ttl: 300,
+            ad: '<!-- adtag -->',
+          },
+        ],
+      };
       const response = spec.interpretResponse(serverResponse);
 
       expect(response).deep.equal(serverResponse.body);
     });
-  })
+  });
 });

package/test/spec/modules/automatadBidAdapter_spec.js

@@ -5,7 +5,25 @@ import { newBidder } from 'src/adapters/bidderFactory.js'
 describe('automatadBidAdapter', function () {
   const adapter = newBidder(spec)
 
-  let bidRequest = {
+  let bidRequestRequiredParams = {
+    bidder: 'automatad',
+    params: {siteId: '123ad'},
+    mediaTypes: {
+      banner: {
+        sizes: [[300, 600]],
+      }
+    },
+    adUnitCode: 'some-ad-unit-code',
+    transactionId: '1465569e-52cc-4c36-88a1-7174cfef4b44',
+    sizes: [[300, 600]],
+    bidId: '123abc',
+    bidderRequestId: '3213887463c059',
+    auctionId: 'abc-123',
+    src: 'client',
+    bidRequestsCount: 1
+  }
+
+  let bidRequestAllParams = {
     bidder: 'automatad',
     params: {siteId: '123ad', placementId: '123abc345'},
     mediaTypes: {
@@ -59,10 +77,14 @@ describe('automatadBidAdapter', function () {
   })
 
   describe('isBidRequestValid', function () {
-    let inValidBid = Object.assign({}, bidRequest)
+    let inValidBid = Object.assign({}, bidRequestRequiredParams)
     delete inValidBid.params
     it('should return true if all params present', function () {
-      expect(spec.isBidRequestValid(bidRequest)).to.equal(true)
+      expect(spec.isBidRequestValid(bidRequestAllParams)).to.equal(true)
+    })
+
+    it('should return true if only required params present', function() {
+      expect(spec.isBidRequestValid(bidRequestRequiredParams)).to.equal(true)
     })
 
     it('should return false if any parameter missing', function () {
@@ -71,7 +93,7 @@ describe('automatadBidAdapter', function () {
   })
 
   describe('buildRequests', function () {
-    let req = spec.buildRequests([ bidRequest ], { refererInfo: { } })
+    let req = spec.buildRequests([ bidRequestRequiredParams ], { refererInfo: { } })
     let rdata
 
     it('should return request object', function () {
@@ -87,9 +109,9 @@ describe('automatadBidAdapter', function () {
       expect(rdata.imp.length).to.equal(1)
     })
 
-    it('should include placement', function () {
+    it('should include siteId', function () {
       let r = rdata.imp[0]
-      expect(r.placement !== null).to.be.true
+      expect(r.siteId !== null).to.be.true
     })
 
     it('should include media types', function () {
@@ -97,11 +119,6 @@ describe('automatadBidAdapter', function () {
       expect(r.media_types !== null).to.be.true
     })
 
-    it('should include all publisher params', function () {
-      let r = rdata.imp[0]
-      expect(r.siteID !== null && r.placementID !== null).to.be.true
-    })
-
     it('should include adunit code', function () {
       let r = rdata.imp[0]
       expect(r.adUnitCode !== null).to.be.true

package/test/spec/modules/criteoBidAdapter_spec.js

@@ -23,7 +23,7 @@ describe('The Criteo bidding adapter', function () {
     sandbox = sinon.sandbox.create();
   });
 
-  afterEach(function() {
+  afterEach(function () {
     global.Criteo = undefined;
     utilsMock.restore();
     sandbox.restore();
@@ -457,7 +457,7 @@ describe('The Criteo bidding adapter', function () {
           params: {
             zoneId: 123,
             publisherSubId: '123',
-            nativeCallback: function() {},
+            nativeCallback: function () { },
             integrationMode: 'amp'
           },
         },
@@ -521,7 +521,7 @@ describe('The Criteo bidding adapter', function () {
             }
           },
           params: {
-            nativeCallback: function() {}
+            nativeCallback: function () { }
           },
         },
       ];
@@ -540,7 +540,7 @@ describe('The Criteo bidding adapter', function () {
             }
           },
           params: {
-            nativeCallback: function() {}
+            nativeCallback: function () { }
           },
         },
       ];
@@ -852,7 +852,7 @@ describe('The Criteo bidding adapter', function () {
           sizes: [[300, 250]],
           mediaTypes: {
             video: {
-              playerSize: [ [300, 250] ],
+              playerSize: [[300, 250]],
               mimes: ['video/mp4', 'video/MPV', 'video/H264', 'video/webm', 'video/ogg'],
               minduration: 1,
               maxduration: 30,
@@ -970,7 +970,7 @@ describe('The Criteo bidding adapter', function () {
     });
 
     it('should properly build a request with first party data', function () {
-      const contextData = {
+      const siteData = {
         keywords: ['power tools'],
         ext: {
           data: {
@@ -1015,7 +1015,7 @@ describe('The Criteo bidding adapter', function () {
       sandbox.stub(config, 'getConfig').callsFake(key => {
         const config = {
           ortb2: {
-            site: contextData,
+            site: siteData,
             user: userData
           }
         };
@@ -1023,8 +1023,8 @@ describe('The Criteo bidding adapter', function () {
       });
 
       const request = spec.buildRequests(bidRequests, bidderRequest);
-      expect(request.data.publisher.ext).to.deep.equal({keywords: ['power tools'], data: {pageType: 'article'}});
-      expect(request.data.user.ext).to.deep.equal({gender: 'M', data: {registered: true}});
+      expect(request.data.publisher.ext).to.deep.equal({ data: { pageType: 'article' } });
+      expect(request.data.user.ext).to.deep.equal({ data: { registered: true } });
       expect(request.data.slots[0].ext).to.deep.equal({
         bidfloor: 0.75,
         data: {
@@ -1171,13 +1171,13 @@ describe('The Criteo bidding adapter', function () {
               'advertiser': {
                 'description': 'sponsor',
                 'domain': 'criteo.com',
-                'logo': {'url': 'https://www.criteo.com/images/criteo-logo.svg', 'height': 300, 'width': 300}
+                'logo': { 'url': 'https://www.criteo.com/images/criteo-logo.svg', 'height': 300, 'width': 300 }
               },
               'privacy': {
                 'optout_click_url': 'https://info.criteo.com/privacy/informations',
                 'optout_image_url': 'https://static.criteo.net/flash/icon/nai_small.png',
               },
-              'impression_pixels': [{'url': 'https://my-impression-pixel/test/impression'}, {'url': 'https://cas.com/lg.com'}]
+              'impression_pixels': [{ 'url': 'https://my-impression-pixel/test/impression' }, { 'url': 'https://cas.com/lg.com' }]
             }
           }],
         },
@@ -1201,7 +1201,7 @@ describe('The Criteo bidding adapter', function () {
     });
 
     it('should warn only once if sendTargetingKeys set to true on required fields for native bidRequest', () => {
-      const bidderRequest = { };
+      const bidderRequest = {};
       const bidRequests = [
         {
           bidder: 'criteo',
@@ -1211,7 +1211,7 @@ describe('The Criteo bidding adapter', function () {
           params: {
             zoneId: 123,
             publisherSubId: '123',
-            nativeCallback: function() {}
+            nativeCallback: function () { }
           },
         },
         {
@@ -1222,7 +1222,7 @@ describe('The Criteo bidding adapter', function () {
           params: {
             zoneId: 456,
             publisherSubId: '456',
-            nativeCallback: function() {}
+            nativeCallback: function () { }
           },
         },
       ];
@@ -1276,7 +1276,7 @@ describe('The Criteo bidding adapter', function () {
         .withArgs('Criteo: all native assets containing URL should be sent as placeholders with sendId(icon, image, clickUrl, displayUrl, privacyLink, privacyIcon)')
         .exactly(nativeParamsWithSendTargetingKeys.length * bidRequests.length);
       nativeParamsWithSendTargetingKeys.forEach(nativeParams => {
-        let transformedBidRequests = {...bidRequests};
+        let transformedBidRequests = { ...bidRequests };
         transformedBidRequests = [Object.assign(transformedBidRequests[0], nativeParams), Object.assign(transformedBidRequests[1], nativeParams)];
         spec.buildRequests(transformedBidRequests, bidderRequest);
       });
@@ -1440,7 +1440,7 @@ describe('The Criteo bidding adapter', function () {
 
   describe('when pubtag prebid adapter is not available', function () {
     it('should not warn if sendId is provided on required fields for native bidRequest', () => {
-      const bidderRequest = { };
+      const bidderRequest = {};
       const bidRequestsWithSendId = [
         {
           bidder: 'criteo',
@@ -1450,7 +1450,7 @@ describe('The Criteo bidding adapter', function () {
           params: {
             zoneId: 123,
             publisherSubId: '123',
-            nativeCallback: function() {}
+            nativeCallback: function () { }
           },
           nativeParams: {
             image: {
@@ -1481,7 +1481,7 @@ describe('The Criteo bidding adapter', function () {
     });
 
     it('should warn only once if sendId is not provided on required fields for native bidRequest', () => {
-      const bidderRequest = { };
+      const bidderRequest = {};
       const bidRequests = [
         {
           bidder: 'criteo',
@@ -1491,7 +1491,7 @@ describe('The Criteo bidding adapter', function () {
           params: {
             zoneId: 123,
             publisherSubId: '123',
-            nativeCallback: function() {}
+            nativeCallback: function () { }
           },
         },
         {
@@ -1502,7 +1502,7 @@ describe('The Criteo bidding adapter', function () {
           params: {
             zoneId: 456,
             publisherSubId: '456',
-            nativeCallback: function() {}
+            nativeCallback: function () { }
           },
         },
       ];
@@ -1556,7 +1556,7 @@ describe('The Criteo bidding adapter', function () {
         .withArgs('Criteo: all native assets containing URL should be sent as placeholders with sendId(icon, image, clickUrl, displayUrl, privacyLink, privacyIcon)')
         .exactly(nativeParamsWithoutSendId.length * bidRequests.length);
       nativeParamsWithoutSendId.forEach(nativeParams => {
-        let transformedBidRequests = {...bidRequests};
+        let transformedBidRequests = { ...bidRequests };
         transformedBidRequests = [Object.assign(transformedBidRequests[0], nativeParams), Object.assign(transformedBidRequests[1], nativeParams)];
         spec.buildRequests(transformedBidRequests, bidderRequest);
       });
@@ -1569,10 +1569,10 @@ describe('The Criteo bidding adapter', function () {
       const response = {};
       const request = {};
 
-      const adapter = { interpretResponse: function() {} };
+      const adapter = { interpretResponse: function () { } };
       const adapterMock = sinon.mock(adapter);
       adapterMock.expects('interpretResponse').withExactArgs(response, request).once().returns('ok');
-      const prebidAdapter = { GetAdapter: function() {} };
+      const prebidAdapter = { GetAdapter: function () { } };
       const prebidAdapterMock = sinon.mock(prebidAdapter);
       prebidAdapterMock.expects('GetAdapter').withExactArgs(request).once().returns(adapter);
 
@@ -1592,10 +1592,10 @@ describe('The Criteo bidding adapter', function () {
     it('should forward bid to pubtag when calling onBidWon', () => {
       const bid = { auctionId: 123 };
 
-      const adapter = { handleBidWon: function() {} };
+      const adapter = { handleBidWon: function () { } };
       const adapterMock = sinon.mock(adapter);
       adapterMock.expects('handleBidWon').withExactArgs(bid).once();
-      const prebidAdapter = { GetAdapter: function() {} };
+      const prebidAdapter = { GetAdapter: function () { } };
       const prebidAdapterMock = sinon.mock(prebidAdapter);
       prebidAdapterMock.expects('GetAdapter').withExactArgs(bid.auctionId).once().returns(adapter);
 
@@ -1615,10 +1615,10 @@ describe('The Criteo bidding adapter', function () {
     it('should forward bid to pubtag when calling onSetTargeting', () => {
       const bid = { auctionId: 123 };
 
-      const adapter = { handleSetTargeting: function() {} };
+      const adapter = { handleSetTargeting: function () { } };
       const adapterMock = sinon.mock(adapter);
       adapterMock.expects('handleSetTargeting').withExactArgs(bid).once();
-      const prebidAdapter = { GetAdapter: function() {} };
+      const prebidAdapter = { GetAdapter: function () { } };
       const prebidAdapterMock = sinon.mock(prebidAdapter);
       prebidAdapterMock.expects('GetAdapter').withExactArgs(bid.auctionId).once().returns(adapter);
 
@@ -1638,10 +1638,10 @@ describe('The Criteo bidding adapter', function () {
     it('should forward bid to pubtag when calling onTimeout', () => {
       const timeoutData = [{ auctionId: 123 }];
 
-      const adapter = { handleBidTimeout: function() {} };
+      const adapter = { handleBidTimeout: function () { } };
       const adapterMock = sinon.mock(adapter);
       adapterMock.expects('handleBidTimeout').once();
-      const prebidAdapter = { GetAdapter: function() {} };
+      const prebidAdapter = { GetAdapter: function () { } };
       const prebidAdapterMock = sinon.mock(prebidAdapter);
       prebidAdapterMock.expects('GetAdapter').withExactArgs(timeoutData[0].auctionId).once().returns(adapter);
 
@@ -1659,15 +1659,15 @@ describe('The Criteo bidding adapter', function () {
     });
 
     it('should return a POST method with url & data from pubtag', () => {
-      const bidRequests = { };
-      const bidderRequest = { };
+      const bidRequests = {};
+      const bidderRequest = {};
 
-      const prebidAdapter = { buildCdbUrl: function() {}, buildCdbRequest: function() {} };
+      const prebidAdapter = { buildCdbUrl: function () { }, buildCdbRequest: function () { } };
       const prebidAdapterMock = sinon.mock(prebidAdapter);
       prebidAdapterMock.expects('buildCdbUrl').once().returns('cdbUrl');
       prebidAdapterMock.expects('buildCdbRequest').once().returns('cdbRequest');
 
-      const adapters = { Prebid: function() {} };
+      const adapters = { Prebid: function () { } };
       const adaptersMock = sinon.mock(adapters);
       adaptersMock.expects('Prebid').withExactArgs(PROFILE_ID_PUBLISHERTAG, ADAPTER_VERSION, bidRequests, bidderRequest, '$prebid.version$').once().returns(prebidAdapter);
 

package/test/spec/modules/eids_spec.js

@@ -363,6 +363,23 @@ describe('eids array generation for known sub-modules', function() {
       }]
     });
   });
+
+  it('33acrossId', function() {
+    const userId = {
+      '33acrossId': {
+        envelope: 'some-random-id-value'
+      }
+    };
+    const newEids = createEidsArray(userId);
+    expect(newEids.length).to.equal(1);
+    expect(newEids[0]).to.deep.equal({
+      source: '33across.com',
+      uids: [{
+        id: 'some-random-id-value',
+        atype: 1
+      }]
+    });
+  });
 });
 describe('Negative case', function() {
   it('eids array generation for UN-known sub-module', function() {