prebid.js 7.26.0 → 7.28.0

package/test/spec/modules/enrichmentFpdModule_spec.js

@@ -1,4 +1,5 @@
 import { expect } from 'chai';
+import {config} from 'src/config.js';
 import { getRefererInfo } from 'src/refererDetection.js';
 import {processFpd, coreStorage, resetEnrichments} from 'modules/enrichmentFpdModule.js';
 import * as enrichmentModule from 'modules/enrichmentFpdModule.js';
@@ -77,10 +78,10 @@ describe('the first party data enrichment module', function() {
     expect(validated.site.keywords).to.be.undefined;
   });
 
-  it('adds page domain values if canonical url exists', function() {
+  it('adds page domain values if pageUrl url exists', function() {
+    config.setConfig({'pageUrl': 'https://www.subdomain.domain.co.uk/path?query=12345'});
     width = 800;
     height = 500;
-    canonical.href = 'https://www.subdomain.domain.co.uk/path?query=12345';
 
     let validated = syncProcessFpd({}, {}).global;
 

package/test/spec/modules/eplanningAnalyticsAdapter_spec.js

@@ -152,9 +152,6 @@ describe('eplanning analytics adapter', function () {
 
       // Step 10 check that the host to send the ajax request is configurable via options
       expect(eplAnalyticsAdapter.context.host).to.equal(initOptions.host);
-
-      // Step 11 verify that we received 7 events (6 E-Planning events + 1 Clean.io event)
-      sinon.assert.callCount(eplAnalyticsAdapter.track, 7);
     });
   });
 });

package/test/spec/modules/eplanningBidAdapter_spec.js

@@ -840,7 +840,7 @@ describe('E-Planning Adapter', function () {
     });
 
     it('should correctly map the parameters in the response vast', function () {
-      const bidResponse = spec.interpretResponse(responseVast, { adUnitToBidId: { [CLEAN_ADUNIT_CODE_VAST]: BID_ID } })[0];
+      const bidResponse = spec.interpretResponse(responseVast, { adUnitToBidId: { [CLEAN_ADUNIT_CODE_VAST]: BID_ID }, data: { vv: 2 } })[0];
       const expectedResponse = {
         requestId: BID_ID,
         cpm: CPM,
@@ -851,13 +851,13 @@ describe('E-Planning Adapter', function () {
         netRevenue: true,
         currency: 'USD',
         vastXml: ADM_VAST,
-        mediaTypes: VIDEO
+        mediaType: VIDEO
       };
       expect(bidResponse).to.deep.equal(expectedResponse);
     });
 
     it('should correctly map the parameters in the response vast vv 1', function () {
-      const bidResponse = spec.interpretResponse(responseVastVV1, { adUnitToBidId: { [CLEAN_ADUNIT_CODE_VAST]: BID_ID } })[0];
+      const bidResponse = spec.interpretResponse(responseVastVV1, { adUnitToBidId: { [CLEAN_ADUNIT_CODE_VAST]: BID_ID }, data: { vv: 1 } })[0];
       const expectedResponse = {
         requestId: BID_ID,
         cpm: CPM,
@@ -868,7 +868,7 @@ describe('E-Planning Adapter', function () {
         netRevenue: true,
         currency: 'USD',
         vastXml: ADM_VAST_VV_1,
-        mediaTypes: VIDEO
+        mediaType: VIDEO
       };
       expect(bidResponse).to.deep.equal(expectedResponse);
     });

package/test/spec/modules/fluctBidAdapter_spec.js

@@ -94,7 +94,12 @@ describe('fluctAdapter', function () {
       expect(request.data.params.kv).to.eql(undefined);
     });
 
-    it('includes filtered user.eids if any exists', function () {
+    it('includes no data.schain by default', function () {
+      const request = spec.buildRequests(bidRequests, bidderRequest)[0];
+      expect(request.data.schain).to.eql(undefined);
+    });
+
+    it('includes filtered user.eids if any exist', function () {
       const bidRequests2 = bidRequests.map(
         (bidReq) => Object.assign(bidReq, {
           userIdAsEids: [
@@ -175,6 +180,37 @@ describe('fluctAdapter', function () {
         imsids: ['imsid1', 'imsid2']
       });
     });
+
+    it('includes data.schain if any exists', function () {
+      // this should be done by schain.js
+      const bidRequests2 = bidRequests.map(
+        (bidReq) => Object.assign(bidReq, {
+          schain: {
+            ver: '1.0',
+            complete: 1,
+            nodes: [
+              {
+                asi: 'example.com',
+                sid: 'publisher-id',
+                hp: 1
+              }
+            ]
+          }
+        })
+      );
+      const request = spec.buildRequests(bidRequests2, bidderRequest)[0];
+      expect(request.data.schain).to.eql({
+        ver: '1.0',
+        complete: 1,
+        nodes: [
+          {
+            asi: 'example.com',
+            sid: 'publisher-id',
+            hp: 1
+          }
+        ]
+      });
+    });
   });
 
   describe('interpretResponse', function() {

package/test/spec/modules/fpdModule_spec.js

@@ -130,7 +130,7 @@ describe('the first party data module', function () {
         }
       };
 
-      canonical.href = 'https://www.domain.com/path?query=12345';
+      config.setConfig({'pageUrl': 'https://www.domain.com/path?query=12345'});
       width = 1120;
       height = 750;
 

package/test/spec/modules/gdprEnforcement_spec.js

@@ -20,6 +20,7 @@ import * as events from 'src/events.js';
 import 'modules/appnexusBidAdapter.js'; // some tests expect this to be in the adapter registry
 import 'src/prebid.js'
 import {hook} from '../../../src/hook.js';
+import {VENDORLESS_GVLID} from '../../../src/consentHandler.js';
 
 describe('gdpr enforcement', function () {
   let nextFnSpy;
@@ -150,13 +151,13 @@ describe('gdpr enforcement', function () {
         }
       });
 
-      deviceAccessHook(nextFnSpy, false);
+      deviceAccessHook(nextFnSpy);
       expect(nextFnSpy.calledOnce).to.equal(true);
       let result = {
         hasEnforcementHook: true,
         valid: false
       }
-      sinon.assert.calledWith(nextFnSpy, false, undefined, undefined, result);
+      sinon.assert.calledWith(nextFnSpy, undefined, undefined, result);
     });
 
     it('should only check for consent for vendor exceptions when enforcePurpose and enforceVendor are false', function () {
@@ -178,8 +179,8 @@ describe('gdpr enforcement', function () {
       consentData.apiVersion = 2;
       gdprDataHandlerStub.returns(consentData);
 
-      deviceAccessHook(nextFnSpy, false, 1, 'appnexus');
-      deviceAccessHook(nextFnSpy, false, 5, 'rubicon');
+      deviceAccessHook(nextFnSpy, 1, 'appnexus');
+      deviceAccessHook(nextFnSpy, 5, 'rubicon');
       expect(logWarnSpy.callCount).to.equal(0);
     });
 
@@ -201,8 +202,8 @@ describe('gdpr enforcement', function () {
       consentData.apiVersion = 2;
       gdprDataHandlerStub.returns(consentData);
 
-      deviceAccessHook(nextFnSpy, false, 1, 'appnexus');
-      deviceAccessHook(nextFnSpy, false, 3, 'rubicon');
+      deviceAccessHook(nextFnSpy, 1, 'appnexus');
+      deviceAccessHook(nextFnSpy, 3, 'rubicon');
       expect(logWarnSpy.callCount).to.equal(1);
     });
 
@@ -224,13 +225,13 @@ describe('gdpr enforcement', function () {
       consentData.apiVersion = 2;
       gdprDataHandlerStub.returns(consentData);
 
-      deviceAccessHook(nextFnSpy, false, 1, 'appnexus');
+      deviceAccessHook(nextFnSpy, 1, 'appnexus');
       expect(nextFnSpy.calledOnce).to.equal(true);
       let result = {
         hasEnforcementHook: true,
         valid: true
       }
-      sinon.assert.calledWith(nextFnSpy, false, 1, 'appnexus', result);
+      sinon.assert.calledWith(nextFnSpy, 1, 'appnexus', result);
     });
 
     it('should use gvlMapping set by publisher', function() {
@@ -255,13 +256,13 @@ describe('gdpr enforcement', function () {
       consentData.apiVersion = 2;
       gdprDataHandlerStub.returns(consentData);
 
-      deviceAccessHook(nextFnSpy, false, 1, 'appnexus');
+      deviceAccessHook(nextFnSpy, 1, 'appnexus');
       expect(nextFnSpy.calledOnce).to.equal(true);
       let result = {
         hasEnforcementHook: true,
         valid: true
       }
-      sinon.assert.calledWith(nextFnSpy, false, 4, 'appnexus', result);
+      sinon.assert.calledWith(nextFnSpy, 4, 'appnexus', result);
       config.resetConfig();
     });
 
@@ -290,31 +291,17 @@ describe('gdpr enforcement', function () {
       consentData.apiVersion = 2;
       gdprDataHandlerStub.returns(consentData);
 
-      deviceAccessHook(nextFnSpy, false, 1, 'appnexus');
+      deviceAccessHook(nextFnSpy, 1, 'appnexus');
       expect(nextFnSpy.calledOnce).to.equal(true);
       let result = {
         hasEnforcementHook: true,
         valid: true
       }
-      sinon.assert.calledWith(nextFnSpy, false, 4, 'appnexus', result);
+      sinon.assert.calledWith(nextFnSpy, 4, 'appnexus', result);
       config.resetConfig();
       curBidderStub.restore();
     });
 
-    it(`should mark module as vendorless for rule validation when isVendorless = true and ${STRICT_STORAGE_ENFORCEMENT} is set`, () => {
-      setEnforcementConfig({
-        [STRICT_STORAGE_ENFORCEMENT]: true
-      });
-      let consentData = {
-        vendorData: staticConfig.consentData.getTCData,
-        gdprApplies: true
-      }
-      gdprDataHandlerStub.returns(consentData);
-      const validate = sinon.stub().callsFake(() => true);
-      deviceAccessHook(nextFnSpy, true, 123, 'mockModule', undefined, {validate});
-      expect(validate.args[0][4]('mockModule')).to.be.true;
-    });
-
     it(`should not enforce consent for vendorless modules if ${STRICT_STORAGE_ENFORCEMENT} is not set`, () => {
       setEnforcementConfig({});
       let consentData = {
@@ -323,9 +310,9 @@ describe('gdpr enforcement', function () {
       }
       gdprDataHandlerStub.returns(consentData);
       const validate = sinon.stub().callsFake(() => false);
-      deviceAccessHook(nextFnSpy, true, 123, 'mockModule', undefined, {validate});
+      deviceAccessHook(nextFnSpy, VENDORLESS_GVLID, 'mockModule', undefined, {validate});
       sinon.assert.callCount(validate, 0);
-      sinon.assert.calledWith(nextFnSpy, true, 123, 'mockModule', {hasEnforcementHook: true, valid: true});
+      sinon.assert.calledWith(nextFnSpy, VENDORLESS_GVLID, 'mockModule', {hasEnforcementHook: true, valid: true});
     })
   });
 
@@ -804,11 +791,12 @@ describe('gdpr enforcement', function () {
   });
 
   describe('validateRules', function () {
-    const createGdprRule = (purposeName = 'storage', enforcePurpose = true, enforceVendor = true, vendorExceptions = []) => ({
+    const createGdprRule = (purposeName = 'storage', enforcePurpose = true, enforceVendor = true, vendorExceptions = [], softVendorExceptions = []) => ({
       purpose: purposeName,
-      enforcePurpose: enforcePurpose,
-      enforceVendor: enforceVendor,
-      vendorExceptions: vendorExceptions
+      enforcePurpose,
+      enforceVendor,
+      vendorExceptions,
+      softVendorExceptions,
     });
 
     const consentData = {
@@ -922,6 +910,19 @@ describe('gdpr enforcement', function () {
       expect(isAllowed).to.equal(true);
     });
 
+    describe('when the vendor has a softVendorException', () => {
+      const gdprRule = createGdprRule('storage', true, true, [], [vendorBlockedModule]);
+
+      it('should return false if general consent was not given', () => {
+        const isAllowed = validateRules(gdprRule, consentDataWithPurposeConsentFalse, vendorBlockedModule, vendorBlockedGvlId);
+        expect(isAllowed).to.be.false;
+      })
+      it('should return true if general consent was given', () => {
+        const isAllowed = validateRules(gdprRule, consentData, vendorBlockedModule, vendorBlockedGvlId);
+        expect(isAllowed).to.be.true;
+      })
+    })
+
     describe('when module does not need vendor consent', () => {
       Object.entries({
         'storage': 1,
@@ -937,11 +938,9 @@ describe('gdpr enforcement', function () {
             it(`should be ${t} when purpose is ${t}`, () => {
               const consent = utils.deepClone(consentData);
               consent.vendorData.purpose.consents[purposeNo] = consentGiven;
-              // vendor consent (and gvlid) should be ignored
-              consent.vendorData.vendor.consents[123] = !consentGiven;
               // take legitimate interest out of the picture for this test
               consent.vendorData.purpose.legitimateInterests = {};
-              const actual = validateRules(rule, consent, 'mockModule', 123, () => true);
+              const actual = validateRules(rule, consent, 'mockModule', VENDORLESS_GVLID);
               expect(actual).to.equal(consentGiven);
             })
           })
@@ -1131,56 +1130,104 @@ describe('gdpr enforcement', function () {
     })
   });
 
-  describe('getGvlid', function() {
+  describe('gvlid resolution', () => {
     let sandbox;
-    let getGvlidForBidAdapterStub;
-    let getGvlidForUserIdModuleStub;
-    let getGvlidForAnalyticsAdapterStub;
     beforeEach(function() {
       sandbox = sinon.createSandbox();
-      getGvlidForBidAdapterStub = sandbox.stub(internal, 'getGvlidForBidAdapter');
-      getGvlidForUserIdModuleStub = sandbox.stub(internal, 'getGvlidForUserIdModule');
-      getGvlidForAnalyticsAdapterStub = sandbox.stub(internal, 'getGvlidForAnalyticsAdapter');
     });
+
     afterEach(function() {
       sandbox.restore();
       config.resetConfig();
     });
 
-    it('should return "null" if called without passing any argument', function() {
-      const gvlid = getGvlid();
-      expect(gvlid).to.equal(null);
-    });
+    describe('getGvlid', function() {
+      let getGvlidForBidAdapterStub;
+      let getGvlidForUserIdModuleStub;
+      let getGvlidForAnalyticsAdapterStub;
+      beforeEach(function() {
+        getGvlidForBidAdapterStub = sandbox.stub(internal, 'getGvlidForBidAdapter');
+        getGvlidForUserIdModuleStub = sandbox.stub(internal, 'getGvlidForUserIdModule');
+        getGvlidForAnalyticsAdapterStub = sandbox.stub(internal, 'getGvlidForAnalyticsAdapter');
+      });
 
-    it('should return "null" if GVL ID is not defined for any of these modules: Bid adapter, UserId submodule and Analytics adapter', function() {
-      getGvlidForBidAdapterStub.withArgs('moduleA').returns(null);
-      getGvlidForUserIdModuleStub.withArgs('moduleA').returns(null);
-      getGvlidForAnalyticsAdapterStub.withArgs('moduleA').returns(null);
+      it('should return "null" if called without passing any argument', function() {
+        const gvlid = getGvlid();
+        expect(gvlid).to.equal(null);
+      });
 
-      const gvlid = getGvlid('moduleA');
-      expect(gvlid).to.equal(null);
-    });
+      it('should return "null" if GVL ID is not defined for any of these modules: Bid adapter, UserId submodule and Analytics adapter', function() {
+        getGvlidForBidAdapterStub.withArgs('moduleA').returns(null);
+        getGvlidForUserIdModuleStub.withArgs('moduleA').returns(null);
+        getGvlidForAnalyticsAdapterStub.withArgs('moduleA').returns(null);
 
-    it('should return the GVL ID from gvlMapping if it is defined in setConfig', function() {
-      config.setConfig({
-        gvlMapping: {
-          moduleA: 1
-        }
+        const gvlid = getGvlid('moduleA');
+        expect(gvlid).to.equal(null);
+      });
+
+      it('should return the GVL ID from gvlMapping if it is defined in setConfig', function() {
+        config.setConfig({
+          gvlMapping: {
+            moduleA: 1
+          }
+        });
+
+        // Actual GVL ID for moduleA is 2, as defined on its the bidAdapter.js file.
+        getGvlidForBidAdapterStub.withArgs('moduleA').returns(2);
+
+        const gvlid = getGvlid('moduleA');
+        expect(gvlid).to.equal(1);
       });
 
-      // Actual GVL ID for moduleA is 2, as defined on its the bidAdapter.js file.
-      getGvlidForBidAdapterStub.withArgs('moduleA').returns(2);
+      it('should return the GVL ID by calling getGvlidForBidAdapter -> getGvlidForUserIdModule -> getGvlidForAnalyticsAdapter in sequence', function() {
+        getGvlidForBidAdapterStub.withArgs('moduleA').returns(null);
+        getGvlidForUserIdModuleStub.withArgs('moduleA').returns(null);
+        getGvlidForAnalyticsAdapterStub.withArgs('moduleA').returns(7);
+
+        expect(getGvlid('moduleA')).to.equal(7);
+      });
 
-      const gvlid = getGvlid('moduleA');
-      expect(gvlid).to.equal(1);
+      it('should pass extra arguments to analytics\' getGvlid', () => {
+        getGvlidForAnalyticsAdapterStub.withArgs('analytics').returns(321);
+        const cfg = {some: 'args'};
+        getGvlid('analytics', cfg);
+        sinon.assert.calledWith(getGvlidForAnalyticsAdapterStub, 'analytics', cfg);
+      });
     });
 
-    it('should return the GVL ID by calling getGvlidForBidAdapter -> getGvlidForUserIdModule -> getGvlidForAnalyticsAdapter in sequence', function() {
-      getGvlidForBidAdapterStub.withArgs('moduleA').returns(null);
-      getGvlidForUserIdModuleStub.withArgs('moduleA').returns(null);
-      getGvlidForAnalyticsAdapterStub.withArgs('moduleA').returns(7);
+    describe('getGvlidForAnalyticsAdapter', () => {
+      let getAnalyticsAdapter, adapter, adapterEntry;
+
+      beforeEach(() => {
+        adapter = {};
+        adapterEntry = {
+          adapter
+        };
+        getAnalyticsAdapter = sandbox.stub(adapterManager, 'getAnalyticsAdapter');
+        getAnalyticsAdapter.withArgs('analytics').returns(adapterEntry);
+      });
+
+      it('should return gvlid from adapterManager if defined', () => {
+        adapterEntry.gvlid = 123;
+        adapter.gvlid = 321
+        expect(internal.getGvlidForAnalyticsAdapter('analytics')).to.equal(123);
+      });
+
+      it('should return gvlid from adapter if defined', () => {
+        adapter.gvlid = 321;
+        expect(internal.getGvlidForAnalyticsAdapter('analytics')).to.equal(321);
+      });
 
-      expect(getGvlid('moduleA')).to.equal(7);
+      it('should invoke adapter.gvlid if it\'s a function', () => {
+        adapter.gvlid = (cfg) => cfg.k
+        const cfg = {k: 231};
+        expect(internal.getGvlidForAnalyticsAdapter('analytics', cfg)).to.eql(231);
+      });
+
+      it('should not choke if adapter gvlid fn throws', () => {
+        adapter.gvlid = () => { throw new Error(); };
+        expect(internal.getGvlidForAnalyticsAdapter('analytics')).to.not.be.ok;
+      });
     });
-  });
+  })
 });