prebid.js 9.4.1 → 9.6.0

package/test/spec/modules/adagioBidAdapter_spec.js

@@ -277,8 +277,6 @@ describe('Adagio bid adapter', () => {
     it('should send bid request to ENDPOINT_PB via POST', function() {
       sandbox.stub(_internal, 'getDevice').returns({ a: 'a' });
       sandbox.stub(_internal, 'getSite').returns({ domain: 'adagio.io', 'page': 'https://adagio.io/hb' });
-      // sandbox.stub(_internal, 'getPageviewId').returns('1234-567');
-      // sandbox.stub(utils, 'generateUUID').returns('blabla');
 
       const bid01 = new BidRequestBuilder().withParams().build();
       const bidderRequest = new BidderRequestBuilder().build();
@@ -292,7 +290,31 @@ describe('Adagio bid adapter', () => {
       expect(requests[0].data).to.have.all.keys(expectedDataKeys);
     });
 
-    it('should use a custom generated auctionId and remove transactionId', function() {
+    it('should use a custom generated auctionId from ortb2.site.ext.data.adg_rtd.uid when available', function() {
+      const expectedAuctionId = '373bcda7-9794-4f1c-be2c-0d223d11d579'
+
+      const bid01 = new BidRequestBuilder().withParams().build();
+      let ortb = {
+        ortb2: {
+          site: {
+            ext: {
+              data: {
+                adg_rtd: {
+                  uid: expectedAuctionId
+                }
+              }
+            }
+          }
+        }
+      }
+      const bidderRequest = new BidderRequestBuilder(ortb).build();
+
+      const requests = spec.buildRequests([bid01], bidderRequest);
+      expect(requests[0].data.adUnits[0].auctionId).eq(expectedAuctionId);
+      expect(requests[0].data.adUnits[0].transactionId).to.not.exist;
+    });
+
+    it('should use a custom generated auctionId when ortb2.site.ext.data.adg_rtd.uid is absent and remove transactionId', function() {
       const expectedAuctionId = '373bcda7-9794-4f1c-be2c-0d223d11d579'
       sandbox.stub(utils, 'generateUUID').returns(expectedAuctionId);
 
@@ -305,9 +327,7 @@ describe('Adagio bid adapter', () => {
     });
 
     it('should enrich prebid bid requests params', function() {
-      const expectedAuctionId = '373bcda7-9794-4f1c-be2c-0d223d11d579'
       const expectedPageviewId = '56befc26-8cf0-472d-b105-73896df8eb89';
-      sandbox.stub(utils, 'generateUUID').returns(expectedAuctionId);
       sandbox.stub(_internal, 'getAdagioNs').returns({ pageviewId: expectedPageviewId });
 
       const bid01 = new BidRequestBuilder().withParams().build();
@@ -315,7 +335,6 @@ describe('Adagio bid adapter', () => {
 
       spec.buildRequests([bid01], bidderRequest);
 
-      expect(bid01.params.adagioAuctionId).eq(expectedAuctionId);
       expect(bid01.params.pageviewId).eq(expectedPageviewId);
     });
 
@@ -782,77 +801,24 @@ describe('Adagio bid adapter', () => {
     describe('with GPP', function() {
       const bid01 = new BidRequestBuilder().withParams().build();
 
-      const regsGpp = 'regs_gpp_consent_string';
-      const regsApplicableSections = [2];
-
-      const ortb2Gpp = 'ortb2_gpp_consent_string';
-      const ortb2GppSid = [1];
-
-      context('When GPP in regs module', function() {
-        it('send gpp and gppSid to the server', function() {
-          const bidderRequest = new BidderRequestBuilder({
-            gppConsent: {
-              gppString: regsGpp,
-              applicableSections: regsApplicableSections,
-            }
-          }).build();
-
-          const requests = spec.buildRequests([bid01], bidderRequest);
-
-          expect(requests[0].data.regs.gpp).to.equal(regsGpp);
-          expect(requests[0].data.regs.gppSid).to.equal(regsApplicableSections);
-        });
-      });
-
-      context('When GPP partially defined in regs module', function() {
-        it('send gpp and gppSid coming from ortb2 to the server', function() {
-          const bidderRequest = new BidderRequestBuilder({
-            gppConsent: {
-              gppString: regsGpp,
-            },
-            ortb2: {
-              regs: {
-                gpp: ortb2Gpp,
-                gpp_sid: ortb2GppSid,
-              }
-            }
-          }).build();
-
-          const requests = spec.buildRequests([bid01], bidderRequest);
-
-          expect(requests[0].data.regs.gpp).to.equal(ortb2Gpp);
-          expect(requests[0].data.regs.gppSid).to.equal(ortb2GppSid);
-        });
-
-        it('send empty gpp and gppSid if no ortb2 fields to the server', function() {
-          const bidderRequest = new BidderRequestBuilder({
-            gppConsent: {
-              gppString: regsGpp,
-            }
-          }).build();
-
-          const requests = spec.buildRequests([bid01], bidderRequest);
-
-          expect(requests[0].data.regs.gpp).to.equal('');
-          expect(requests[0].data.regs.gppSid).to.be.empty;
-        });
-      });
+      const gpp = 'gpp_consent_string';
+      const gppSid = [1];
 
-      context('When GPP defined in ortb2 module', function() {
+      context('When GPP is defined', function() {
         it('send gpp and gppSid coming from ortb2 to the server', function() {
           const bidderRequest = new BidderRequestBuilder({
             ortb2: {
               regs: {
-                gpp: ortb2Gpp,
-                gpp_sid: ortb2GppSid,
+                gpp,
+                gpp_sid: gppSid,
               }
             }
           }).build();
 
           const requests = spec.buildRequests([bid01], bidderRequest);
 
-          expect(requests[0].data.regs.gpp).to.equal(ortb2Gpp);
-          expect(requests[0].data.regs.gppSid).to.equal(ortb2GppSid);
+          expect(requests[0].data.regs.gpp).to.equal(gpp);
+          expect(requests[0].data.regs.gppSid).to.equal(gppSid);
         });
       });
 

package/test/spec/modules/adagioRtdProvider_spec.js

@@ -118,6 +118,7 @@ describe('Adagio Rtd Provider', function () {
     describe('store session data in localStorage', function () {
       const session = {
         lastActivityTime: 1714116520700,
+        id: 'uid-1234',
         rnd: 0.5697,
         vwSmplg: 0.1,
         vwSmplgNxt: 0.1
@@ -128,6 +129,7 @@ describe('Adagio Rtd Provider', function () {
         sandbox.stub(storage, 'getDataFromLocalStorage').callsArgWith(1, storageValue);
         sandbox.stub(Date, 'now').returns(1714116520710);
         sandbox.stub(Math, 'random').returns(0.8);
+        sandbox.stub(utils, 'generateUUID').returns('uid-1234');
 
         const spy = sandbox.spy(_internal.getAdagioNs().queue, 'push')
 
@@ -136,6 +138,7 @@ describe('Adagio Rtd Provider', function () {
         const expected = {
           session: {
             new: true,
+            id: utils.generateUUID(),
             rnd: Math.random()
           }
         }
@@ -176,6 +179,7 @@ describe('Adagio Rtd Provider', function () {
         sandbox.stub(Date, 'now').returns(1715679344351);
         sandbox.stub(storage, 'getDataFromLocalStorage').callsArgWith(1, storageValue);
         sandbox.stub(Math, 'random').returns(0.8);
+        sandbox.stub(utils, 'generateUUID').returns('uid-5678');
 
         const spy = sandbox.spy(_internal.getAdagioNs().queue, 'push')
 
@@ -185,6 +189,7 @@ describe('Adagio Rtd Provider', function () {
           session: {
             ...session,
             new: true,
+            id: utils.generateUUID(),
             rnd: Math.random(),
           }
         }
@@ -196,6 +201,73 @@ describe('Adagio Rtd Provider', function () {
         }).calledOnce).to.be.true;
       });
     });
+
+    describe('store session data in localStorage when used with external AB Test snippet', function () {
+      const sessionWithABTest = {
+        lastActivityTime: 1714116520700,
+        id: 'uid-1234',
+        rnd: 0.5697,
+        vwSmplg: 0.1,
+        vwSmplgNxt: 0.1,
+        testName: 'adg-test',
+        testVersion: 'srv',
+        initiator: 'snippet'
+      };
+
+      it('store new session data instancied by the AB Test snippet for further usage', function () {
+        const sessionWithNewFlag = { ...sessionWithABTest, new: true };
+        const storageValue = JSON.stringify({session: sessionWithNewFlag});
+        sandbox.stub(storage, 'getDataFromLocalStorage').callsArgWith(1, storageValue);
+        sandbox.stub(Date, 'now').returns(1714116520710);
+        sandbox.stub(Math, 'random').returns(0.8);
+
+        const spy = sandbox.spy(_internal.getAdagioNs().queue, 'push')
+
+        adagioRtdSubmodule.init(config);
+
+        const expected = {
+          session: {
+            ...sessionWithNewFlag
+          }
+        }
+
+        expect(spy.withArgs({
+          action: 'session',
+          ts: Date.now(),
+          data: expected,
+        }).calledOnce).to.be.true;
+      });
+
+      it('store new session data after removing AB Test props when initiator is not the snippet', function () {
+        const sessionWithNewFlag = { ...sessionWithABTest, new: false, initiator: 'adgjs' };
+        const storageValue = JSON.stringify({session: sessionWithNewFlag});
+        sandbox.stub(storage, 'getDataFromLocalStorage').callsArgWith(1, storageValue);
+        sandbox.stub(Date, 'now').returns(1714116520710);
+        sandbox.stub(Math, 'random').returns(0.8);
+        sandbox.stub(utils, 'generateUUID').returns('uid-5678');
+
+        const spy = sandbox.spy(_internal.getAdagioNs().queue, 'push')
+
+        adagioRtdSubmodule.init(config);
+
+        const expected = {
+          session: {
+            ...sessionWithNewFlag,
+            new: true,
+            id: utils.generateUUID(),
+            rnd: Math.random(),
+          }
+        }
+        delete expected.session.testName;
+        delete expected.session.testVersion;
+
+        expect(spy.withArgs({
+          action: 'session',
+          ts: Date.now(),
+          data: expected,
+        }).calledOnce).to.be.true;
+      });
+    });
   });
 
   describe('submodule `getBidRequestData`', function () {

package/test/spec/modules/admixerBidAdapter_spec.js

@@ -4,7 +4,7 @@ import {newBidder} from 'src/adapters/bidderFactory.js';
 import {config} from '../../../src/config.js';
 
 const BIDDER_CODE = 'admixer';
-const WL_BIDDER_CODE = 'admixerwl'
+const RTB_BIDDER_CODE = 'rtbstack'
 const ENDPOINT_URL = 'https://inv-nets.admixer.net/prebid.1.2.aspx';
 const ENDPOINT_URL_CUSTOM = 'https://custom.admixer.net/prebid.aspx';
 const ZONE_ID = '2eb6bd58-865c-47ce-af7f-a918108c3fd2';
@@ -37,11 +37,10 @@ describe('AdmixerAdapter', function () {
       auctionId: '1d1a030790a475',
     };
 
-    let wlBid = {
-      bidder: WL_BIDDER_CODE,
+    let rtbBid = {
+      bidder: RTB_BIDDER_CODE,
       params: {
-        clientId: CLIENT_ID,
-        endpointId: ENDPOINT_ID,
+        tagId: ENDPOINT_ID,
       },
       adUnitCode: 'adunit-code',
       sizes: [
@@ -56,8 +55,8 @@ describe('AdmixerAdapter', function () {
     it('should return true when required params found', function () {
       expect(spec.isBidRequestValid(bid)).to.equal(true);
     });
-    it('should return true when params required by WL found', function () {
-      expect(spec.isBidRequestValid(wlBid)).to.equal(true);
+    it('should return true when params required by RTB found', function () {
+      expect(spec.isBidRequestValid(rtbBid)).to.equal(true);
     });
 
     it('should return false when required params are not passed', function () {
@@ -68,8 +67,8 @@ describe('AdmixerAdapter', function () {
       };
       expect(spec.isBidRequestValid(invalidBid)).to.equal(false);
     });
-    it('should return false when params required by WL are not passed', function () {
-      let invalidBid = Object.assign({}, wlBid);
+    it('should return false when params required by RTB are not passed', function () {
+      let invalidBid = Object.assign({}, rtbBid);
       delete invalidBid.params;
       invalidBid.params = {
         clientId: 0,
@@ -118,7 +117,7 @@ describe('AdmixerAdapter', function () {
     it('sends bid request to CUSTOM_ENDPOINT via GET', function () {
       config.setBidderConfig({
         bidders: [BIDDER_CODE], // one or more bidders
-        config: { [BIDDER_CODE]: { endpoint_url: ENDPOINT_URL_CUSTOM } },
+        config: { bidderURL: ENDPOINT_URL_CUSTOM },
       });
       const request = config.runWithBidder(BIDDER_CODE, () =>
         spec.buildRequests(validRequest, bidderRequest)
@@ -133,9 +132,8 @@ describe('AdmixerAdapter', function () {
       validRequest: [
         {
           bidder: bidder,
-          params: bidder === 'admixerwl' ? {
-            clientId: CLIENT_ID,
-            endpointId: ENDPOINT_ID
+          params: bidder === 'rtbstack' ? {
+            tagId: ENDPOINT_ID
           } : {
             zone: ZONE_ID,
           },
@@ -193,10 +191,16 @@ describe('AdmixerAdapter', function () {
       expect(request.url).to.equal('https://inv-nets.admixer.net/adxprebid.1.2.aspx');
       expect(request.method).to.equal('POST');
     });
-    it('build request for admixerwl', function () {
-      const requestParams = requestParamsFor('admixerwl');
-      const request = spec.buildRequests(requestParams.validRequest, requestParams.bidderRequest);
-      expect(request.url).to.equal(`https://inv-nets-adxwl.admixer.com/adxwlprebid.aspx?client=${CLIENT_ID}`);
+    it('build request for rtbstack', function () {
+      const requestParams = requestParamsFor('rtbstack');
+      config.setBidderConfig({
+        bidders: ['rtbstack'],
+        config: { bidderURL: ENDPOINT_URL_CUSTOM },
+      });
+      const request = config.runWithBidder(BIDDER_CODE, () =>
+        spec.buildRequests(requestParams.validRequest, requestParams.bidderRequest)
+      );
+      expect(request.url).to.equal(ENDPOINT_URL_CUSTOM);
       expect(request.method).to.equal('POST');
     });
   });

package/test/spec/modules/advRedAnalyticsAdapter_spec.js

@@ -0,0 +1,114 @@
+import advRedAnalytics from 'modules/advRedAnalyticsAdapter.js';
+import {expect} from 'chai';
+import {server} from 'test/mocks/xhr.js';
+import {expectEvents} from '../../helpers/analytics.js';
+import { EVENTS } from 'src/constants.js';
+import sinon from 'sinon';
+
+let events = require('src/events');
+
+describe('AdvRed Analytics Adapter', function () {
+  let bidWonEvent = {
+    'bidderCode': 'appnexus',
+    'width': 300,
+    'height': 250,
+    'adId': '1ebb82ec35375e',
+    'mediaType': 'banner',
+    'cpm': 0.5,
+    'requestId': '1582271863760569973',
+    'creative_id': '96846035',
+    'creativeId': '96846035',
+    'ttl': 60,
+    'currency': 'USD',
+    'netRevenue': true,
+    'auctionId': '9c7b70b9-b6ab-4439-9e71-b7b382797c18',
+    'responseTimestamp': 1537521629657,
+    'requestTimestamp': 1537521629331,
+    'bidder': 'appnexus',
+    'adUnitCode': 'div-gpt-ad-1460505748561-0',
+    'timeToRespond': 326,
+    'size': '300x250',
+    'status': 'rendered',
+    'eventType': 'bidWon',
+    'ad': 'some ad',
+    'adUrl': 'ad url'
+  };
+
+  describe('AdvRed Analytic tests', function () {
+    beforeEach(function () {
+      sinon.stub(events, 'getEvents').returns([]);
+    });
+
+    afterEach(function () {
+      advRedAnalytics.disableAnalytics();
+      events.getEvents.restore();
+    });
+
+    it('support custom endpoint', function () {
+      let custom_endpoint = 'custom url';
+      advRedAnalytics.enableAnalytics({
+        provider: 'advRed',
+        options: {
+          url: custom_endpoint,
+          publisherId: '1234567890'
+        }
+      });
+
+      expect(advRedAnalytics.getOptions().url).to.equal(custom_endpoint);
+    });
+
+    it('bid won event', function() {
+      let publisherId = '1234567890';
+      advRedAnalytics.enableAnalytics({
+        provider: 'advRed',
+        options: {
+          publisherId: publisherId
+        }
+      });
+
+      events.emit(EVENTS.BID_WON, bidWonEvent);
+      advRedAnalytics.sendEvents();
+
+      expect(server.requests.length).to.equal(1);
+      expect(server.requests[0].url).to.equal('https://api.adv.red/api/event');
+
+      const message = JSON.parse(server.requests[0].requestBody);
+      expect(message.pwId).to.exist;
+      expect(message.publisherId).to.equal(publisherId);
+      expect(message.events.length).to.equal(1);
+      expect(message.events[0].eventType).to.equal('bidWon');
+      expect(message.events[0].ad).to.be.undefined;
+      expect(message.events[0].adUrl).to.be.undefined;
+    });
+
+    it('track event', function () {
+      sinon.spy(advRedAnalytics, 'track');
+
+      advRedAnalytics.enableAnalytics({
+        provider: 'advRed',
+        options: {
+          publisherId: '1234567890'
+        }
+      });
+
+      expectEvents().to.beTrackedBy(advRedAnalytics.track);
+    });
+  });
+
+  describe('pageUrl detection', function () {
+    afterEach(function () {
+      advRedAnalytics.disableAnalytics()
+    });
+    it('check pageUrl property', function () {
+      advRedAnalytics.enableAnalytics({
+        provider: 'advRed',
+        options: {
+          publisherId: '1234567890'
+        }
+      });
+
+      const message = JSON.parse(server.requests[0].requestBody);
+      expect(message.pageUrl).to.equal(window.top.location.href);
+    });
+  });
+});

package/test/spec/modules/adxcgBidAdapter_spec.js

@@ -459,7 +459,7 @@ describe('adxcg v8 oRtbConverter Adapter Tests', function () {
       },
       gdprConsent: {
         gdprApplies: true,
-        consentString: 'serialized_gpdr_data'
+        consentString: 'serialized_gdpr_data'
       },
       ortb2: {
         user: {

package/test/spec/modules/appnexusBidAdapter_spec.js

@@ -431,6 +431,42 @@ describe('AppNexusAdapter', function () {
         expect(payload.tags[0].video_frameworks).to.deep.equal([1, 4])
       });
 
+      it('should convert and include ORTB2 device data when available', function () {
+        const bidRequest = deepClone(bidRequests[0]);
+        const bidderRequest = {
+          ortb2: {
+            device: {
+              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',
+            },
+          },
+        };
+
+        const expectedDeviceResult = {
+          useragent: bidderRequest.ortb2.device.ua,
+          devicetype: 'Mobile/Tablet - General',
+          make: bidderRequest.ortb2.device.make,
+          model: bidderRequest.ortb2.device.model,
+          os: bidderRequest.ortb2.device.os,
+          os_version: bidderRequest.ortb2.device.osv,
+          w: bidderRequest.ortb2.device.w,
+          h: bidderRequest.ortb2.device.h,
+        };
+
+        const request = spec.buildRequests([bidRequest], bidderRequest);
+        const payload = JSON.parse(request.data);
+
+        expect(payload.device).to.deep.equal(expectedDeviceResult);
+      });
+
       it('should add video property when adUnit includes a renderer', function () {
         const videoData = {
           mediaTypes: {

package/test/spec/modules/azerionedgeRtdProvider_spec.js

@@ -8,11 +8,17 @@ describe('Azerion Edge RTD submodule', function () {
     { id: '1', visits: 123 },
     { id: '2', visits: 456 },
   ];
-
+  const IMPROVEDIGITAL_GVLID = '253';
   const key = 'publisher123';
   const bidders = ['appnexus', 'improvedigital'];
   const process = { key: 'value' };
   const dataProvider = { name: 'azerionedge', waitForIt: true };
+  const userConsent = {gdpr: {gdprApplies: 'gdpr-applies', consentString: 'consent-string'}, usp: 'usp'};
+
+  const resetAll = () => {
+    window.azerionPublisherAudiences.resetHistory();
+    loadExternalScript.resetHistory();
+  }
 
   let reqBidsConfigObj;
   let storageStub;
@@ -33,7 +39,11 @@ describe('Azerion Edge RTD submodule', function () {
     let returned;
 
     beforeEach(function () {
-      returned = azerionedgeRTD.azerionedgeSubmodule.init(dataProvider);
+      returned = azerionedgeRTD.azerionedgeSubmodule.init(dataProvider, userConsent);
+    });
+
+    it('should have the correct gvlid', () => {
+      expect(azerionedgeRTD.azerionedgeSubmodule.gvlid).to.equal(IMPROVEDIGITAL_GVLID);
     });
 
     it('should return true', function () {
@@ -49,18 +59,21 @@ describe('Azerion Edge RTD submodule', function () {
       expect(loadExternalScript.args[0][0]).to.deep.equal(expected);
     });
 
-    it('should call azerionPublisherAudiencesStub with empty configuration', function () {
-      expect(window.azerionPublisherAudiences.args[0][0]).to.deep.equal({});
+    [
+      ['gdprApplies', userConsent.gdpr.gdprApplies],
+      ['gdprConsent', userConsent.gdpr.consentString],
+      ['uspConsent', userConsent.usp],
+    ].forEach(([key, value]) => {
+      it(`should call azerionPublisherAudiencesStub with ${key}:${value}`, function () {
+        expect(window.azerionPublisherAudiences.args[0][0]).to.include({[key]: value});
+      });
     });
 
     describe('with key', function () {
       beforeEach(function () {
-        window.azerionPublisherAudiences.resetHistory();
-        loadExternalScript.resetHistory();
-        returned = azerionedgeRTD.azerionedgeSubmodule.init({
-          ...dataProvider,
-          params: { key },
-        });
+        resetAll();
+        const config = { ...dataProvider, params: { key } };
+        returned = azerionedgeRTD.azerionedgeSubmodule.init(config, userConsent);
       });
 
       it('should return true', function () {
@@ -75,22 +88,24 @@ describe('Azerion Edge RTD submodule', function () {
 
     describe('with process configuration', function () {
       beforeEach(function () {
-        window.azerionPublisherAudiences.resetHistory();
-        loadExternalScript.resetHistory();
-        returned = azerionedgeRTD.azerionedgeSubmodule.init({
-          ...dataProvider,
-          params: { process },
-        });
+        resetAll();
+        const config = { ...dataProvider, params: { process } };
+        returned = azerionedgeRTD.azerionedgeSubmodule.init(config, userConsent);
       });
 
       it('should return true', function () {
         expect(returned).to.equal(true);
       });
 
-      it('should call azerionPublisherAudiencesStub with process configuration', function () {
-        expect(window.azerionPublisherAudiences.args[0][0]).to.deep.equal(
-          process
-        );
+      [
+        ['gdprApplies', userConsent.gdpr.gdprApplies],
+        ['gdprConsent', userConsent.gdpr.consentString],
+        ['uspConsent', userConsent.usp],
+        ...Object.entries(process),
+      ].forEach(([key, value]) => {
+        it(`should call azerionPublisherAudiencesStub with ${key}:${value}`, function () {
+          expect(window.azerionPublisherAudiences.args[0][0]).to.include({[key]: value});
+        });
       });
     });
   });
@@ -111,7 +126,7 @@ describe('Azerion Edge RTD submodule', function () {
         );
       });
 
-      it('does not run apply audiences to bidders', function () {
+      it('does not apply audiences to bidders', function () {
         expect(reqBidsConfigObj.ortb2Fragments.bidder).to.deep.equal({});
       });