prebid.js 7.23.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/permutiveRtdProvider_spec.js

@@ -13,13 +13,13 @@ import { deepAccess, deepSetValue, mergeDeep } from '../../../src/utils.js'
 import { config } from 'src/config.js'
 
 describe('permutiveRtdProvider', function () {
-  before(function () {
+  beforeEach(function () {
     const data = getTargetingData()
     setLocalStorage(data)
     config.resetConfig()
   })
 
-  after(function () {
+  afterEach(function () {
     const data = getTargetingData()
     removeLocalStorage(data)
     config.resetConfig()
@@ -317,6 +317,7 @@ describe('permutiveRtdProvider', function () {
         })
       }
     })
+
     it('sets segment targeting for Magnite', function () {
       const data = transformedTargeting()
       const adUnits = getAdUnits()
@@ -337,6 +338,38 @@ describe('permutiveRtdProvider', function () {
         })
       }
     })
+
+    it('sets segment targeting for Magnite video', function () {
+      const targetingData = getTargetingData()
+      targetingData._prubicons.push(321)
+
+      setLocalStorage(targetingData)
+
+      const data = transformedTargeting(targetingData)
+      const config = getConfig()
+
+      const adUnits = getAdUnits().filter(adUnit => adUnit.mediaTypes.video)
+      expect(adUnits).to.have.lengthOf(1)
+
+      initSegments({ adUnits }, callback, config)
+
+      function callback() {
+        adUnits.forEach(adUnit => {
+          adUnit.bids.forEach(bid => {
+            const { bidder, params } = bid
+
+            if (bidder === 'rubicon') {
+              expect(
+                deepAccess(params, 'visitor.permutive'),
+                'Should map all targeting values to a string',
+              ).to.eql(data.rubicon.map(String))
+              expect(deepAccess(params, 'visitor.p_standard')).to.eql(data.ac)
+            }
+          })
+        })
+      }
+    })
+
     it('sets segment targeting for Ozone', function () {
       const data = transformedTargeting()
       const adUnits = getAdUnits()
@@ -516,9 +549,7 @@ function getConfig () {
   }
 }
 
-function transformedTargeting () {
-  const data = getTargetingData()
-
+function transformedTargeting (data = getTargetingData()) {
   return {
     ac: [...data._pcrprs, ...data._ppam, ...data._psegs.filter(seg => seg >= 1000000)],
     appnexus: data._papns,
@@ -640,6 +671,34 @@ function getAdUnits () {
           }
         }
       ]
+    },
+    {
+      code: 'myVideoAdUnit',
+      mediaTypes: {
+        video: {
+          context: 'instream',
+          playerSize: [640, 480],
+          mimes: ['video/mp4', 'video/x-ms-wmv'],
+          protocols: [2, 3, 5, 6],
+          api: [2],
+          maxduration: 30,
+          linearity: 1
+        }
+      },
+      bids: [{
+        bidder: 'rubicon',
+        params: {
+          accountId: '9840',
+          siteId: '123564',
+          zoneId: '583584',
+          video: {
+            language: 'en'
+          },
+          visitor: {
+            test_kv: ['true']
+          }
+        }
+      }]
     }
   ]
 }

package/test/spec/modules/tripleliftBidAdapter_spec.js

@@ -979,6 +979,20 @@ describe('triplelift adapter', function () {
       expect(url).to.match(new RegExp('(?:' + prebid.version + ')'))
       expect(url).to.match(/(?:referrer)/);
     });
+    it('should prioritize topmostLocation for referrer', function () {
+      bidderRequest.refererInfo.topmostLocation = 'https://topmostlocation.com?foo=bar'
+      const request = tripleliftAdapterSpec.buildRequests(bidRequests, bidderRequest);
+      const url = request.url;
+      expect(url).to.match(/(\?|&)referrer=https%3A%2F%2Ftopmostlocation.com%3Ffoo%3Dbar/);
+      delete bidderRequest.refererInfo.topmostLocation
+    });
+    it('should fall back to page for referrer if topmostLocation is unavailable', function () {
+      bidderRequest.refererInfo.topmostLocation = null
+      const request = tripleliftAdapterSpec.buildRequests(bidRequests, bidderRequest);
+      const url = request.url;
+      expect(url).to.match(/(\?|&)referrer=https%3A%2F%2Fexamplereferer.com/);
+      delete bidderRequest.refererInfo.topmostLocation
+    });
     it('should return us_privacy param when CCPA info is available', function() {
       bidderRequest.uspConsent = '1YYY';
       const request = tripleliftAdapterSpec.buildRequests(bidRequests, bidderRequest);

package/test/spec/unit/pbjs_api_spec.js

@@ -1615,6 +1615,19 @@ describe('Unit: Prebid Module', function () {
     });
 
     describe('returns a promise that resolves', () => {
+      function delayHook(next, ...args) {
+        setTimeout(() => next(...args))
+      }
+
+      beforeEach(() => {
+        // make sure the return value works correctly when hooks give up priority
+        $$PREBID_GLOBAL$$.requestBids.before(delayHook)
+      });
+
+      afterEach(() => {
+        $$PREBID_GLOBAL$$.requestBids.getHooks({hook: delayHook}).remove();
+      });
+
       Object.entries({
         'immediately, without bidsBackHandler': (req) => $$PREBID_GLOBAL$$.requestBids(req),
         'after bidsBackHandler': (() => {
@@ -1665,7 +1678,10 @@ describe('Unit: Prebid Module', function () {
               sinon.assert.match(bids[bid.adUnitCode].bids[0], bid)
               done();
             });
-            completeAuction([bid]);
+            // `completeAuction` won't work until we're out of `delayHook`
+            // and the mocked auction has been set up;
+            // setTimeout here takes us after the setTimeout in `delayHook`
+            setTimeout(() => completeAuction([bid]));
           })
         })
       })