prebid.js 7.22.0 → 7.24.0

package/test/spec/modules/mgidRtdProvider_spec.js

@@ -0,0 +1,366 @@
+import { mgidSubmodule, storage } from '../../../modules/mgidRtdProvider.js';
+import {expect} from 'chai';
+import * as refererDetection from '../../../src/refererDetection';
+
+describe('Mgid RTD submodule', () => {
+  let server;
+  let clock;
+  let getRefererInfoStub;
+  let getDataFromLocalStorageStub;
+
+  beforeEach(() => {
+    server = sinon.fakeServer.create();
+
+    clock = sinon.useFakeTimers();
+
+    getRefererInfoStub = sinon.stub(refererDetection, 'getRefererInfo');
+    getRefererInfoStub.returns({
+      canonicalUrl: 'https://www.test.com/abc'
+    });
+
+    getDataFromLocalStorageStub = sinon.stub(storage, 'getDataFromLocalStorage').returns('qwerty654321');
+  });
+
+  afterEach(() => {
+    server.restore();
+    clock.restore();
+    getRefererInfoStub.restore();
+    getDataFromLocalStorageStub.restore();
+  });
+
+  it('init is successfull, when clientSiteId is defined', () => {
+    expect(mgidSubmodule.init({params: {clientSiteId: 123}})).to.be.true;
+  });
+
+  it('init is unsuccessfull, when clientSiteId is not defined', () => {
+    expect(mgidSubmodule.init({})).to.be.false;
+  });
+
+  it('getBidRequestData send all params to our endpoint and succesfully modifies ortb2', () => {
+    const responseObj = {
+      userSegments: ['100', '200'],
+      userSegtax: 5,
+      siteSegments: ['300', '400'],
+      siteSegtax: 7,
+      muid: 'qwerty654321',
+    };
+
+    let reqBidsConfigObj = {
+      ortb2Fragments: {
+        global: {
+          site: {
+            content: {
+              language: 'en',
+            }
+          }
+        },
+      }
+    };
+
+    let onDone = sinon.stub();
+
+    mgidSubmodule.getBidRequestData(
+      reqBidsConfigObj,
+      onDone,
+      {params: {clientSiteId: 123}},
+      {
+        gdpr: {
+          gdprApplies: true,
+          consentString: 'testConsent',
+        },
+        usp: '1YYY',
+      }
+    );
+
+    server.requests[0].respond(
+      200,
+      {'Content-Type': 'application/json'},
+      JSON.stringify(responseObj)
+    );
+
+    const requestUrl = new URL(server.requests[0].url);
+    expect(requestUrl.host).to.be.eq('servicer.mgid.com');
+    expect(requestUrl.searchParams.get('gdprApplies')).to.be.eq('true');
+    expect(requestUrl.searchParams.get('consentData')).to.be.eq('testConsent');
+    expect(requestUrl.searchParams.get('uspString')).to.be.eq('1YYY');
+    expect(requestUrl.searchParams.get('muid')).to.be.eq('qwerty654321');
+    expect(requestUrl.searchParams.get('clientSiteId')).to.be.eq('123');
+    expect(requestUrl.searchParams.get('cxurl')).to.be.eq('https://www.test.com/abc');
+    expect(requestUrl.searchParams.get('cxlang')).to.be.eq('en');
+
+    assert.deepInclude(
+      reqBidsConfigObj.ortb2Fragments.global,
+      {
+        site: {
+          content: {
+            language: 'en',
+            data: [
+              {
+                name: 'www.mgid.com',
+                ext: {
+                  segtax: 7
+                },
+                segment: [
+                  { id: '300' },
+                  { id: '400' },
+                ]
+              }
+            ],
+          }
+        },
+        user: {
+          data: [
+            {
+              name: 'www.mgid.com',
+              ext: {
+                segtax: 5
+              },
+              segment: [
+                { id: '100' },
+                { id: '200' },
+              ]
+            }
+          ],
+        },
+      });
+  });
+
+  it('getBidRequestData doesn\'t send params (consent and cxlang), if we haven\'t received them', () => {
+    let reqBidsConfigObj = {
+      ortb2Fragments: {
+        global: {},
+      }
+    };
+
+    let onDone = sinon.stub();
+
+    mgidSubmodule.getBidRequestData(
+      reqBidsConfigObj,
+      onDone,
+      {params: {clientSiteId: 123}},
+      {}
+    );
+
+    server.requests[0].respond(
+      200,
+      {'Content-Type': 'application/json'},
+      JSON.stringify({})
+    );
+
+    const requestUrl = new URL(server.requests[0].url);
+    expect(requestUrl.host).to.be.eq('servicer.mgid.com');
+    expect(requestUrl.searchParams.get('gdprApplies')).to.be.null;
+    expect(requestUrl.searchParams.get('consentData')).to.be.null;
+    expect(requestUrl.searchParams.get('uspString')).to.be.null;
+    expect(requestUrl.searchParams.get('muid')).to.be.eq('qwerty654321');
+    expect(requestUrl.searchParams.get('clientSiteId')).to.be.eq('123');
+    expect(requestUrl.searchParams.get('cxurl')).to.be.eq('https://www.test.com/abc');
+    expect(requestUrl.searchParams.get('cxlang')).to.be.null;
+    expect(onDone.calledOnce).to.be.true;
+  });
+
+  it('getBidRequestData send gdprApplies event if it is false', () => {
+    let reqBidsConfigObj = {
+      ortb2Fragments: {
+        global: {},
+      }
+    };
+
+    let onDone = sinon.stub();
+
+    mgidSubmodule.getBidRequestData(
+      reqBidsConfigObj,
+      onDone,
+      {params: {clientSiteId: 123}},
+      {
+        gdpr: {
+          gdprApplies: false,
+          consentString: 'testConsent',
+        },
+        usp: '1YYY',
+      }
+    );
+
+    server.requests[0].respond(
+      200,
+      {'Content-Type': 'application/json'},
+      JSON.stringify({})
+    );
+
+    const requestUrl = new URL(server.requests[0].url);
+    expect(requestUrl.host).to.be.eq('servicer.mgid.com');
+    expect(requestUrl.searchParams.get('gdprApplies')).to.be.eq('false');
+    expect(requestUrl.searchParams.get('consentData')).to.be.eq('testConsent');
+    expect(requestUrl.searchParams.get('uspString')).to.be.eq('1YYY');
+    expect(requestUrl.searchParams.get('muid')).to.be.eq('qwerty654321');
+    expect(requestUrl.searchParams.get('clientSiteId')).to.be.eq('123');
+    expect(requestUrl.searchParams.get('cxurl')).to.be.eq('https://www.test.com/abc');
+    expect(requestUrl.searchParams.get('cxlang')).to.be.null;
+    expect(onDone.calledOnce).to.be.true;
+  });
+
+  it('getBidRequestData use og:url for cxurl, if it is available', () => {
+    let reqBidsConfigObj = {
+      ortb2Fragments: {
+        global: {},
+      }
+    };
+
+    let onDone = sinon.stub();
+
+    let metaStub = sinon.stub(document, 'getElementsByTagName').returns([
+      { getAttribute: () => 'og:test', content: 'fake' },
+      { getAttribute: () => 'og:url', content: 'https://realOgUrl.com/' }
+    ]);
+
+    mgidSubmodule.getBidRequestData(
+      reqBidsConfigObj,
+      onDone,
+      {params: {clientSiteId: 123}},
+      {}
+    );
+
+    server.requests[0].respond(
+      200,
+      {'Content-Type': 'application/json'},
+      JSON.stringify({})
+    );
+
+    const requestUrl = new URL(server.requests[0].url);
+    expect(requestUrl.searchParams.get('cxurl')).to.be.eq('https://realOgUrl.com/');
+    expect(onDone.calledOnce).to.be.true;
+
+    metaStub.restore();
+  });
+
+  it('getBidRequestData use topMostLocation for cxurl, if nothing else left', () => {
+    let reqBidsConfigObj = {
+      ortb2Fragments: {
+        global: {},
+      }
+    };
+
+    let onDone = sinon.stub();
+
+    getRefererInfoStub.returns({
+      topmostLocation: 'https://www.test.com/topMost'
+    });
+
+    mgidSubmodule.getBidRequestData(
+      reqBidsConfigObj,
+      onDone,
+      {params: {clientSiteId: 123}},
+      {}
+    );
+
+    server.requests[0].respond(
+      200,
+      {'Content-Type': 'application/json'},
+      JSON.stringify({})
+    );
+
+    const requestUrl = new URL(server.requests[0].url);
+    expect(requestUrl.searchParams.get('cxurl')).to.be.eq('https://www.test.com/topMost');
+    expect(onDone.calledOnce).to.be.true;
+  });
+
+  it('getBidRequestData won\'t modify ortb2 if response is broken', () => {
+    let reqBidsConfigObj = {
+      ortb2Fragments: {
+        global: {},
+      }
+    };
+
+    let onDone = sinon.stub();
+
+    mgidSubmodule.getBidRequestData(
+      reqBidsConfigObj,
+      onDone,
+      {params: {clientSiteId: 123}},
+      {}
+    );
+
+    server.requests[0].respond(
+      200,
+      {'Content-Type': 'application/json'},
+      '{'
+    );
+
+    assert.deepEqual(reqBidsConfigObj.ortb2Fragments.global, {});
+    expect(onDone.calledOnce).to.be.true;
+  });
+
+  it('getBidRequestData won\'t modify ortb2 if response status is not 200', () => {
+    let reqBidsConfigObj = {
+      ortb2Fragments: {
+        global: {},
+      }
+    };
+
+    let onDone = sinon.stub();
+
+    mgidSubmodule.getBidRequestData(
+      reqBidsConfigObj,
+      onDone,
+      {params: {clientSiteId: 123}},
+      {}
+    );
+
+    server.requests[0].respond(
+      204,
+      {'Content-Type': 'application/json'},
+      '{}'
+    );
+
+    assert.deepEqual(reqBidsConfigObj.ortb2Fragments.global, {});
+    expect(onDone.calledOnce).to.be.true;
+  });
+
+  it('getBidRequestData won\'t modify ortb2 if response results in error', () => {
+    let reqBidsConfigObj = {
+      ortb2Fragments: {
+        global: {},
+      }
+    };
+
+    let onDone = sinon.stub();
+
+    mgidSubmodule.getBidRequestData(
+      reqBidsConfigObj,
+      onDone,
+      {params: {clientSiteId: 123}},
+      {}
+    );
+
+    server.requests[0].respond(
+      500,
+      {'Content-Type': 'application/json'},
+      '{}'
+    );
+
+    assert.deepEqual(reqBidsConfigObj.ortb2Fragments.global, {});
+    expect(onDone.calledOnce).to.be.true;
+  });
+
+  it('getBidRequestData won\'t modify ortb2 if response time hits timeout', () => {
+    let reqBidsConfigObj = {
+      ortb2Fragments: {
+        global: {},
+      }
+    };
+
+    let onDone = sinon.stub();
+
+    mgidSubmodule.getBidRequestData(
+      reqBidsConfigObj,
+      onDone,
+      {params: {clientSiteId: 123, timeout: 500}},
+      {}
+    );
+
+    clock.tick(510);
+
+    assert.deepEqual(reqBidsConfigObj.ortb2Fragments.global, {});
+    expect(onDone.calledOnce).to.be.true;
+  });
+});

package/test/spec/modules/openxOrtbBidAdapter_spec.js

@@ -4,6 +4,16 @@ import {newBidder} from 'src/adapters/bidderFactory.js';
 import {BANNER, VIDEO} from 'src/mediaTypes.js';
 import {config} from 'src/config.js';
 import * as utils from 'src/utils.js';
+// load modules that register ORTB processors
+import 'src/prebid.js'
+import 'modules/currency.js';
+import 'modules/userId/index.js';
+import 'modules/multibid/index.js';
+import 'modules/priceFloors.js';
+import 'modules/consentManagement.js';
+import 'modules/consentManagementUsp.js';
+import 'modules/schain.js';
+import {deepClone} from 'src/utils.js';
 
 const DEFAULT_SYNC = SYNC_URL + '?ph=' + DEFAULT_PH;
 
@@ -632,7 +642,7 @@ describe('OpenxRtbAdapter', function () {
           it('should not send the regs object, when consent string is undefined', function () {
             delete bidderRequest.uspConsent;
             const request = spec.buildRequests(bidRequests, bidderRequest);
-            expect(request[0].data.regs).to.not.have.property('ext');
+            expect(request[0].data.regs?.us_privacy).to.not.exist;
           });
         });
 
@@ -698,8 +708,7 @@ describe('OpenxRtbAdapter', function () {
             delete bidderRequest.gdprConsent.gdprApplies;
             bidderRequest.bids = bidRequests;
             const request = spec.buildRequests(bidRequests, bidderRequest);
-            expect(request[0].data.regs).to.not.have.property('ext');
-            expect(request[1].data.regs).to.not.have.property('ext');
+            expect(request[0].data.regs?.ext?.gdpr).to.not.be.ok;
             expect(request[0].data.user.ext.consent).to.equal(bidderRequest.gdprConsent.consentString);
             expect(request[1].data.user.ext.consent).to.equal(bidderRequest.gdprConsent.consentString);
           });
@@ -717,7 +726,7 @@ describe('OpenxRtbAdapter', function () {
       context('coppa', function() {
         it('when there are no coppa param settings, should not send a coppa flag', function () {
           const request = spec.buildRequests(bidRequestsWithMediaTypes, mockBidderRequest);
-          expect(request[0].data.regs.coppa).to.equal(0);
+          expect(request[0].data.regs?.coppa).to.be.not.ok;
         });
 
         it('should send a coppa flag there is when there is coppa param settings in the bid requests', function () {
@@ -1081,55 +1090,57 @@ describe('OpenxRtbAdapter', function () {
       });
     });
 
-    context('when there is a response, the common response properties', function () {
-      beforeEach(function () {
-        bidRequestConfigs = [{
-          bidder: 'openx',
-          params: {
-            unit: '12345678',
-            delDomain: 'test-del-domain'
-          },
-          adUnitCode: 'adunit-code',
-          mediaTypes: {
-            banner: {
-              sizes: [[300, 250], [300, 600]],
-            },
-          },
-          bidId: 'test-bid-id',
-          bidderRequestId: 'test-bidder-request-id',
-          auctionId: 'test-auction-id'
-        }];
-
-        bidRequest = spec.buildRequests(bidRequestConfigs, {refererInfo: {}})[0];
-
-        bidResponse = {
-          seatbid: [{
-            bid: [{
-              impid: 'test-bid-id',
-              price: 2,
-              w: 300,
-              h: 250,
-              crid: 'test-creative-id',
-              dealid: 'test-deal-id',
-              adm: 'test-ad-markup',
-              adomain: ['brand.com'],
-              ext: {
-                dsp_id: '123',
-                buyer_id: '456',
-                brand_id: '789',
-                paf: {
-                  content_id: 'paf_content_id'
-                }
-              }
-            }]
-          }],
-          cur: 'AUS',
+    const SAMPLE_BID_REQUESTS = [{
+      bidder: 'openx',
+      params: {
+        unit: '12345678',
+        delDomain: 'test-del-domain'
+      },
+      adUnitCode: 'adunit-code',
+      mediaTypes: {
+        banner: {
+          sizes: [[300, 250], [300, 600]],
+        },
+      },
+      bidId: 'test-bid-id',
+      bidderRequestId: 'test-bidder-request-id',
+      auctionId: 'test-auction-id'
+    }];
+
+    const SAMPLE_BID_RESPONSE = {
+      seatbid: [{
+        bid: [{
+          impid: 'test-bid-id',
+          price: 2,
+          w: 300,
+          h: 250,
+          crid: 'test-creative-id',
+          dealid: 'test-deal-id',
+          adm: 'test-ad-markup',
+          adomain: ['brand.com'],
           ext: {
+            dsp_id: '123',
+            buyer_id: '456',
+            brand_id: '789',
             paf: {
-              transmission: {version: '12'}
+              content_id: 'paf_content_id'
             }
           }
-        };
+        }]
+      }],
+      cur: 'AUS',
+      ext: {
+        paf: {
+          transmission: {version: '12'}
+        }
+      }
+    };
+
+    context('when there is a response, the common response properties', function () {
+      beforeEach(function () {
+        bidRequestConfigs = deepClone(SAMPLE_BID_REQUESTS);
+        bidRequest = spec.buildRequests(bidRequestConfigs, {refererInfo: {}})[0];
+        bidResponse = deepClone(SAMPLE_BID_RESPONSE);
 
         bid = spec.interpretResponse({body: bidResponse}, bidRequest)[0];
       });
@@ -1196,6 +1207,23 @@ describe('OpenxRtbAdapter', function () {
       });
     });
 
+    context('when there is more than one response', () => {
+      let bids;
+      beforeEach(function () {
+        bidRequestConfigs = deepClone(SAMPLE_BID_REQUESTS);
+        bidRequest = spec.buildRequests(bidRequestConfigs, {refererInfo: {}})[0];
+        bidResponse = deepClone(SAMPLE_BID_RESPONSE);
+        bidResponse.seatbid[0].bid.push(deepClone(bidResponse.seatbid[0].bid[0]));
+        bidResponse.seatbid[0].bid[1].ext.paf.content_id = 'second_paf'
+
+        bids = spec.interpretResponse({body: bidResponse}, bidRequest);
+      });
+
+      it('should not confuse paf content_id', () => {
+        expect(bids.map(b => b.meta.paf.content_id)).to.eql(['paf_content_id', 'second_paf']);
+      });
+    })
+
     context('when the response is a banner', function() {
       beforeEach(function () {
         bidRequestConfigs = [{

package/test/spec/modules/oxxionRtdProvider_spec.js

@@ -0,0 +1,142 @@
+import {oxxionSubmodule} from 'modules/oxxionRtdProvider.js';
+import 'src/prebid.js';
+
+const utils = require('src/utils.js');
+
+const moduleConfig = {
+  params: {
+    domain: 'test.endpoint',
+    contexts: ['instream', 'outstream']
+  }
+};
+
+let request = {
+  'auctionId': '1e8b993d-8f0a-4232-83eb-3639ddf3a44b',
+  'timestamp': 1647424261187,
+  'auctionEnd': 1647424261714,
+  'auctionStatus': 'completed',
+  'adUnits': [
+    {
+      'code': 'msq_tag_200124_banner',
+      'mediaTypes': { 'banner': { 'sizes': [[300, 600]] } },
+      'bids': [{'bidder': 'appnexus', 'params': {'placementId': 123456}}],
+      'transactionId': 'de664ccb-e18b-4436-aeb0-362382eb1b40'
+    },
+    {
+      'code': 'msq_tag_200125_video',
+      'mediaTypes': { 'video': { 'context': 'instream' }, playerSize: [640, 480], mimes: ['video/mp4'] },
+      'bids': [
+        {'bidder': 'mediasquare', 'params': {'code': 'publishername_atf_desktop_rg_video', 'owner': 'test'}},
+        {'bidder': 'appnexusAst', 'params': {'placementId': 345678}},
+      ],
+      'transactionId': 'de664ccb-e18b-4436-aeb0-362382eb1b41'
+    },
+  ]
+};
+
+let bids = [{
+  'bidderCode': 'mediasquare',
+  'width': 640,
+  'height': 480,
+  'statusMessage': 'Bid available',
+  'adId': '3647626fdbe68a',
+  'requestId': '2d891705d2125b',
+  'transactionId': 'de664ccb-e18b-4436-aeb0-362382eb1b41',
+  'auctionId': '1e8b993d-8f0a-4232-83eb-3639ddf3a44b',
+  'mediaType': 'video',
+  'source': 'client',
+  'cpm': 0.9723,
+  'creativeId': 'freewheel|AdswizzAd71819',
+  'currency': 'USD',
+  'netRevenue': true,
+  'ttl': 2000,
+  'mediasquare': {
+    'bidder': 'freewheel',
+    'code': 'test/publishername_atf_desktop_rg_video',
+    'hasConsent': true
+  },
+  'meta': {
+    'advertiserDomains': [
+      'unknown'
+    ]
+  },
+  'vastUrl': 'https://some.vast-url.com',
+  'vastXml': '<VAST version="3.0"><Ad><Wrapper><VASTAdTagURI><![CDATA[https://pbs-front.mediasquare.fr/cache?uuid=4de68767e8f2f9974fd4addd5a9d135a]]></VASTAdTagURI><Impression><![CDATA[https://pbs-front.mediasquare.fr/winning?adUnitCode=&auctionId=ZltsQnBqbcyC6aalwAdD4irnXmrl3E&bidder=freewheel&code=test/publishername_atf_desktop_rg_video&cpm=0.9723&creativeId=AdswizzAd71819&currency=USD&hasConsent=true&mediaType=video&pbjs=&requestId=2d891705d2125b&size=video&timeToRespond=unknown]]></Impression></Wrapper></Ad></VAST>',
+  'adapterCode': 'mediasquare',
+  'originalCpm': 0.9723,
+  'originalCurrency': 'USD',
+  'responseTimestamp': 1665505150740,
+  'requestTimestamp': 1665505150594,
+  'bidder': 'mediasquare',
+  'adUnitCode': 'msq_tag_200125_video',
+  'timeToRespond': 146,
+  'size': '640x480',
+}, {
+  'bidderCode': 'appnexusAst',
+  'width': 640,
+  'height': 480,
+  'statusMessage': 'Bid available',
+  'adId': '4b2e1581c0ca1a',
+  'requestId': '2d891705d2125b',
+  'transactionId': 'de664ccb-e18b-4436-aeb0-362382eb1b41',
+  'auctionId': '1e8b993d-8f0a-4232-83eb-3639ddf3a44b',
+  'mediaType': 'video',
+  'source': 'client',
+  'cpm': 1.9723,
+  'creativeId': '159080650',
+  'currency': 'USD',
+  'netRevenue': true,
+  'ttl': 2000,
+  'vastUrl': 'https://some.vast-url.com',
+  'vastXml': '<VAST version="3.0"><Ad><InLine><AdSystem>Adnxs</AdSystem><AdTitle>Title</AdTitle><Creatives/></InLine></Ad></VAST>',
+  'adapterCode': 'mediasquare',
+  'originalCpm': 1.9723,
+  'originalCurrency': 'USD',
+  'responseTimestamp': 1665505150740,
+  'requestTimestamp': 1665505150594,
+  'bidder': 'appnexusAst',
+  'adUnitCode': 'msq_tag_200125_video',
+  'timeToRespond': 146,
+  'size': '640x480',
+  'vastImpUrl': 'https://some.tracking-url.com'
+},
+];
+
+describe('oxxionRtdProvider', () => {
+  describe('Oxxion RTD sub module', () => {
+    it('should init, return true, and set the params', () => {
+      expect(oxxionSubmodule.init(moduleConfig)).to.equal(true);
+    });
+  });
+
+  describe('Oxxion RTD sub module', () => {
+    let auctionEnd = request;
+    auctionEnd.bidsReceived = bids;
+    it('call everything', function() {
+      oxxionSubmodule.getBidRequestData(request, null, moduleConfig);
+      oxxionSubmodule.onAuctionEndEvent(auctionEnd, moduleConfig);
+    });
+    it('check vastImpUrl', function() {
+      expect(auctionEnd.bidsReceived[0]).to.have.property('vastImpUrl');
+      let expectVastImpUrl = 'https://' + moduleConfig.params.domain + '.oxxion.io/analytics/vast_imp?';
+      expect(auctionEnd.bidsReceived[1].vastImpUrl).to.contain(expectVastImpUrl);
+      expect(auctionEnd.bidsReceived[1].vastImpUrl).to.contain(encodeURI('https://some.tracking-url.com'));
+    });
+    it('check vastXml', function() {
+      expect(auctionEnd.bidsReceived[0]).to.have.property('vastXml');
+      let vastWrapper = new DOMParser().parseFromString(auctionEnd.bidsReceived[0].vastXml, 'text/xml');
+      let impressions = vastWrapper.querySelectorAll('VAST Ad Wrapper Impression');
+      expect(impressions.length).to.equal(2);
+      expect(auctionEnd.bidsReceived[1]).to.have.property('vastXml');
+      expect(auctionEnd.bidsReceived[1].adId).to.equal('4b2e1581c0ca1a');
+      let vastInline = new DOMParser().parseFromString(auctionEnd.bidsReceived[1].vastXml, 'text/xml');
+      let inline = vastInline.querySelectorAll('VAST Ad InLine');
+      expect(inline).to.have.lengthOf(1);
+      let inlineImpressions = vastInline.querySelectorAll('VAST Ad InLine Impression');
+      expect(inlineImpressions).to.have.lengthOf.above(0);
+    });
+    it('check cpmIncrement', function() {
+      expect(auctionEnd.bidsReceived[1].vastImpUrl).to.contain(encodeURI('cpmIncrement=1'));
+    });
+  });
+});