prebid.js 9.0.0 → 9.2.0

package/test/spec/modules/mobfoxpbBidAdapter_spec.js

@@ -1,148 +1,268 @@
-import {expect} from 'chai';
-import {spec} from '../../../modules/mobfoxpbBidAdapter.js';
+import { expect } from 'chai';
+import { spec } from '../../../modules/mobfoxpbBidAdapter.js';
 import { BANNER, VIDEO, NATIVE } from '../../../src/mediaTypes.js';
+import { getUniqueIdentifierStr } from '../../../src/utils.js';
+
+const bidder = 'mobfoxpb';
 
 describe('MobfoxHBBidAdapter', function () {
-  const bid = {
-    bidId: '23fhj33i987f',
-    bidder: 'mobfoxpb',
+  const userIdAsEids = [{
+    source: 'test.org',
+    uids: [{
+      id: '01**********',
+      atype: 1,
+      ext: {
+        third: '01***********'
+      }
+    }]
+  }];
+  const bids = [
+    {
+      bidId: getUniqueIdentifierStr(),
+      bidder: bidder,
+      mediaTypes: {
+        [BANNER]: {
+          sizes: [[300, 250]]
+        }
+      },
+      params: {
+        placementId: 'testBanner'
+      },
+      userIdAsEids
+    },
+    {
+      bidId: getUniqueIdentifierStr(),
+      bidder: bidder,
+      mediaTypes: {
+        [VIDEO]: {
+          playerSize: [[300, 300]],
+          minduration: 5,
+          maxduration: 60
+        }
+      },
+      params: {
+        placementId: 'testVideo'
+      },
+      userIdAsEids
+    },
+    {
+      bidId: getUniqueIdentifierStr(),
+      bidder: bidder,
+      mediaTypes: {
+        [NATIVE]: {
+          native: {
+            title: {
+              required: true
+            },
+            body: {
+              required: true
+            },
+            icon: {
+              required: true,
+              size: [64, 64]
+            }
+          }
+        }
+      },
+      params: {
+        placementId: 'testNative'
+      },
+      userIdAsEids
+    }
+  ];
+
+  const invalidBid = {
+    bidId: getUniqueIdentifierStr(),
+    bidder: bidder,
     mediaTypes: {
       [BANNER]: {
         sizes: [[300, 250]]
       }
     },
     params: {
-      placementId: 783,
-      traffic: BANNER
+
     }
-  };
+  }
 
   const bidderRequest = {
+    uspConsent: '1---',
+    gdprConsent: {
+      consentString: 'COvFyGBOvFyGBAbAAAENAPCAAOAAAAAAAAAAAEEUACCKAAA.IFoEUQQgAIQwgIwQABAEAAAAOIAACAIAAAAQAIAgEAACEAAAAAgAQBAAAAAAAGBAAgAAAAAAAFAAECAAAgAAQARAEQAAAAAJAAIAAgAAAYQEAAAQmAgBC3ZAYzUw',
+      vendorData: {}
+    },
     refererInfo: {
-      referer: 'test.com'
+      referer: 'https://test.com',
+      page: 'https://test.com'
     },
-    ortb2: {}
+    ortb2: {
+      device: {
+        w: 1512,
+        h: 982,
+        language: 'en-UK'
+      }
+    },
+    timeout: 500
   };
 
   describe('isBidRequestValid', function () {
     it('Should return true if there are bidId, params and key parameters present', function () {
-      expect(spec.isBidRequestValid(bid)).to.be.true;
+      expect(spec.isBidRequestValid(bids[0])).to.be.true;
     });
     it('Should return false if at least one of parameters is not present', function () {
-      delete bid.params.placementId;
-      expect(spec.isBidRequestValid(bid)).to.be.false;
+      expect(spec.isBidRequestValid(invalidBid)).to.be.false;
     });
   });
 
   describe('buildRequests', function () {
-    let serverRequest = spec.buildRequests([bid], bidderRequest);
+    let serverRequest = spec.buildRequests(bids, bidderRequest);
+
     it('Creates a ServerRequest object with method, URL and data', function () {
       expect(serverRequest).to.exist;
       expect(serverRequest.method).to.exist;
       expect(serverRequest.url).to.exist;
       expect(serverRequest.data).to.exist;
     });
+
     it('Returns POST method', function () {
       expect(serverRequest.method).to.equal('POST');
     });
+
     it('Returns valid URL', function () {
       expect(serverRequest.url).to.equal('https://bes.mobfox.com/pbjs');
     });
-    it('Returns valid data if array of bids is valid', function () {
+
+    it('Returns general data valid', function () {
       let data = serverRequest.data;
       expect(data).to.be.an('object');
-      expect(data).to.have.all.keys('deviceWidth', 'deviceHeight', 'language', 'secure', 'host', 'page', 'placements');
+      expect(data).to.have.all.keys('deviceWidth',
+        'deviceHeight',
+        'language',
+        'secure',
+        'host',
+        'page',
+        'placements',
+        'coppa',
+        'ccpa',
+        'gdpr',
+        'tmax'
+      );
       expect(data.deviceWidth).to.be.a('number');
       expect(data.deviceHeight).to.be.a('number');
       expect(data.language).to.be.a('string');
       expect(data.secure).to.be.within(0, 1);
       expect(data.host).to.be.a('string');
       expect(data.page).to.be.a('string');
-      expect(data.gdpr).to.not.exist;
-      expect(data.ccpa).to.not.exist;
-      let placement = data['placements'][0];
-      expect(placement).to.have.keys('placementId', 'bidId', 'traffic', 'sizes', 'schain', 'bidfloor');
-      expect(placement.placementId).to.equal(783);
-      expect(placement.bidId).to.equal('23fhj33i987f');
-      expect(placement.traffic).to.equal(BANNER);
-      expect(placement.schain).to.be.an('object');
-      expect(placement.sizes).to.be.an('array');
-      expect(placement.bidfloor).to.equal(0);
+      expect(data.coppa).to.be.a('number');
+      expect(data.gdpr).to.be.a('object');
+      expect(data.ccpa).to.be.a('string');
+      expect(data.tmax).to.be.a('number');
+      expect(data.placements).to.have.lengthOf(3);
     });
 
-    it('Returns valid data for mediatype video', function () {
-      const playerSize = [300, 300];
-      bid.mediaTypes = {};
-      bid.params.traffic = VIDEO;
-      bid.mediaTypes[VIDEO] = {
-        playerSize
-      };
-      serverRequest = spec.buildRequests([bid], bidderRequest);
-      let data = serverRequest.data;
-      expect(data).to.be.an('object');
-      let placement = data['placements'][0];
-      expect(placement).to.be.an('object');
-      expect(placement).to.have.keys('placementId', 'bidId', 'traffic', 'playerSize', 'wPlayer', 'hPlayer', 'schain', 'bidfloor',
-        'minduration', 'maxduration', 'mimes', 'protocols', 'startdelay', 'placement', 'plcmt',
-        'skip', 'skipafter', 'minbitrate', 'maxbitrate', 'delivery', 'playbackmethod', 'api', 'linearity');
-      expect(placement.traffic).to.equal(VIDEO);
-      expect(placement.wPlayer).to.equal(playerSize[0]);
-      expect(placement.hPlayer).to.equal(playerSize[1]);
+    it('Returns valid placements', function () {
+      const { placements } = serverRequest.data;
+
+      for (let i = 0, len = placements.length; i < len; i++) {
+        const placement = placements[i];
+        expect(placement.placementId).to.be.oneOf(['testBanner', 'testVideo', 'testNative']);
+        expect(placement.adFormat).to.be.oneOf([BANNER, VIDEO, NATIVE]);
+        expect(placement.bidId).to.be.a('string');
+        expect(placement.schain).to.be.an('object');
+        expect(placement.bidfloor).to.exist.and.to.equal(0);
+        expect(placement.type).to.exist.and.to.equal('publisher');
+        expect(placement.eids).to.exist.and.to.be.deep.equal(userIdAsEids);
+
+        if (placement.adFormat === BANNER) {
+          expect(placement.sizes).to.be.an('array');
+        }
+        switch (placement.adFormat) {
+          case BANNER:
+            expect(placement.sizes).to.be.an('array');
+            break;
+          case VIDEO:
+            expect(placement.playerSize).to.be.an('array');
+            expect(placement.minduration).to.be.an('number');
+            expect(placement.maxduration).to.be.an('number');
+            break;
+          case NATIVE:
+            expect(placement.native).to.be.an('object');
+            break;
+        }
+      }
     });
 
-    it('Returns valid data for mediatype native', function () {
-      const native = {
-        title: {
-          required: true
-        },
-        body: {
-          required: true
-        },
-        icon: {
-          required: true,
-          size: [64, 64]
+    it('Returns valid endpoints', function () {
+      const bids = [
+        {
+          bidId: getUniqueIdentifierStr(),
+          bidder: bidder,
+          mediaTypes: {
+            [BANNER]: {
+              sizes: [[300, 250]]
+            }
+          },
+          params: {
+            endpointId: 'testBanner',
+          },
+          userIdAsEids
         }
-      };
+      ];
 
-      bid.mediaTypes = {};
-      bid.params.traffic = NATIVE;
-      bid.mediaTypes[NATIVE] = native;
-      serverRequest = spec.buildRequests([bid], bidderRequest);
-      let data = serverRequest.data;
-      expect(data).to.be.an('object');
-      let placement = data['placements'][0];
-      expect(placement).to.be.an('object');
-      expect(placement).to.have.keys('placementId', 'bidId', 'traffic', 'native', 'schain', 'bidfloor');
-      expect(placement.traffic).to.equal(NATIVE);
-      expect(placement.native).to.equal(native);
+      let serverRequest = spec.buildRequests(bids, bidderRequest);
+
+      const { placements } = serverRequest.data;
+      for (let i = 0, len = placements.length; i < len; i++) {
+        const placement = placements[i];
+        expect(placement.endpointId).to.be.oneOf(['testBanner', 'testVideo', 'testNative']);
+        expect(placement.adFormat).to.be.oneOf([BANNER, VIDEO, NATIVE]);
+        expect(placement.bidId).to.be.a('string');
+        expect(placement.schain).to.be.an('object');
+        expect(placement.bidfloor).to.exist.and.to.equal(0);
+        expect(placement.type).to.exist.and.to.equal('network');
+        expect(placement.eids).to.exist.and.to.be.deep.equal(userIdAsEids);
+
+        if (placement.adFormat === BANNER) {
+          expect(placement.sizes).to.be.an('array');
+        }
+        switch (placement.traffic) {
+          case BANNER:
+            expect(placement.sizes).to.be.an('array');
+            break;
+          case VIDEO:
+            expect(placement.playerSize).to.be.an('array');
+            expect(placement.minduration).to.be.an('number');
+            expect(placement.maxduration).to.be.an('number');
+            break;
+          case NATIVE:
+            expect(placement.native).to.be.an('object');
+            break;
+        }
+      }
     });
 
     it('Returns data with gdprConsent and without uspConsent', function () {
-      bidderRequest.gdprConsent = 'test';
-      serverRequest = spec.buildRequests([bid], bidderRequest);
+      delete bidderRequest.uspConsent;
+      serverRequest = spec.buildRequests(bids, bidderRequest);
       let data = serverRequest.data;
       expect(data.gdpr).to.exist;
-      expect(data.gdpr).to.be.a('string');
-      expect(data.gdpr).to.equal(bidderRequest.gdprConsent);
+      expect(data.gdpr).to.be.a('object');
+      expect(data.gdpr).to.have.property('consentString');
+      expect(data.gdpr).to.not.have.property('vendorData');
+      expect(data.gdpr.consentString).to.equal(bidderRequest.gdprConsent.consentString);
       expect(data.ccpa).to.not.exist;
       delete bidderRequest.gdprConsent;
     });
 
     it('Returns data with uspConsent and without gdprConsent', function () {
-      bidderRequest.uspConsent = 'test';
-      serverRequest = spec.buildRequests([bid], bidderRequest);
+      bidderRequest.uspConsent = '1---';
+      delete bidderRequest.gdprConsent;
+      serverRequest = spec.buildRequests(bids, bidderRequest);
       let data = serverRequest.data;
       expect(data.ccpa).to.exist;
       expect(data.ccpa).to.be.a('string');
       expect(data.ccpa).to.equal(bidderRequest.uspConsent);
       expect(data.gdpr).to.not.exist;
     });
-
-    it('Returns empty data if no valid requests are passed', function () {
-      serverRequest = spec.buildRequests([]);
-      let data = serverRequest.data;
-      expect(data.placements).to.be.an('array').that.is.empty;
-    });
   });
 
   describe('gpp consent', function () {
@@ -152,7 +272,7 @@ describe('MobfoxHBBidAdapter', function () {
         applicableSections: [8]
       };
 
-      let serverRequest = spec.buildRequests([bid], bidderRequest);
+      let serverRequest = spec.buildRequests(bids, bidderRequest);
       let data = serverRequest.data;
       expect(data).to.be.an('object');
       expect(data).to.have.property('gpp');
@@ -162,15 +282,18 @@ describe('MobfoxHBBidAdapter', function () {
     })
 
     it('bidderRequest.ortb2.regs.gpp', () => {
+      bidderRequest.ortb2 = bidderRequest.ortb2 || {};
       bidderRequest.ortb2.regs = bidderRequest.ortb2.regs || {};
       bidderRequest.ortb2.regs.gpp = 'abc123';
       bidderRequest.ortb2.regs.gpp_sid = [8];
 
-      let serverRequest = spec.buildRequests([bid], bidderRequest);
+      let serverRequest = spec.buildRequests(bids, bidderRequest);
       let data = serverRequest.data;
       expect(data).to.be.an('object');
       expect(data).to.have.property('gpp');
       expect(data).to.have.property('gpp_sid');
+
+      bidderRequest.ortb2;
     })
   });
 
@@ -188,7 +311,11 @@ describe('MobfoxHBBidAdapter', function () {
           creativeId: '2',
           netRevenue: true,
           currency: 'USD',
-          dealId: '1'
+          dealId: '1',
+          meta: {
+            advertiserDomains: ['google.com'],
+            advertiserId: 1234
+          }
         }]
       };
       let bannerResponses = spec.interpretResponse(banner);
@@ -196,15 +323,16 @@ describe('MobfoxHBBidAdapter', function () {
       let dataItem = bannerResponses[0];
       expect(dataItem).to.have.all.keys('requestId', 'cpm', 'width', 'height', 'ad', 'ttl', 'creativeId',
         'netRevenue', 'currency', 'dealId', 'mediaType', 'meta');
-      expect(dataItem.requestId).to.equal('23fhj33i987f');
-      expect(dataItem.cpm).to.equal(0.4);
-      expect(dataItem.width).to.equal(300);
-      expect(dataItem.height).to.equal(250);
-      expect(dataItem.ad).to.equal('Test');
-      expect(dataItem.ttl).to.equal(120);
-      expect(dataItem.creativeId).to.equal('2');
+      expect(dataItem.requestId).to.equal(banner.body[0].requestId);
+      expect(dataItem.cpm).to.equal(banner.body[0].cpm);
+      expect(dataItem.width).to.equal(banner.body[0].width);
+      expect(dataItem.height).to.equal(banner.body[0].height);
+      expect(dataItem.ad).to.equal(banner.body[0].ad);
+      expect(dataItem.ttl).to.equal(banner.body[0].ttl);
+      expect(dataItem.creativeId).to.equal(banner.body[0].creativeId);
       expect(dataItem.netRevenue).to.be.true;
-      expect(dataItem.currency).to.equal('USD');
+      expect(dataItem.currency).to.equal(banner.body[0].currency);
+      expect(dataItem.meta).to.be.an('object').that.has.any.key('advertiserDomains');
     });
     it('Should interpret video response', function () {
       const video = {
@@ -217,7 +345,11 @@ describe('MobfoxHBBidAdapter', function () {
           creativeId: '2',
           netRevenue: true,
           currency: 'USD',
-          dealId: '1'
+          dealId: '1',
+          meta: {
+            advertiserDomains: ['google.com'],
+            advertiserId: 1234
+          }
         }]
       };
       let videoResponses = spec.interpretResponse(video);
@@ -233,6 +365,7 @@ describe('MobfoxHBBidAdapter', function () {
       expect(dataItem.creativeId).to.equal('2');
       expect(dataItem.netRevenue).to.be.true;
       expect(dataItem.currency).to.equal('USD');
+      expect(dataItem.meta).to.be.an('object').that.has.any.key('advertiserDomains');
     });
     it('Should interpret native response', function () {
       const native = {
@@ -250,6 +383,10 @@ describe('MobfoxHBBidAdapter', function () {
           creativeId: '2',
           netRevenue: true,
           currency: 'USD',
+          meta: {
+            advertiserDomains: ['google.com'],
+            advertiserId: 1234
+          }
         }]
       };
       let nativeResponses = spec.interpretResponse(native);
@@ -269,6 +406,7 @@ describe('MobfoxHBBidAdapter', function () {
       expect(dataItem.creativeId).to.equal('2');
       expect(dataItem.netRevenue).to.be.true;
       expect(dataItem.currency).to.equal('USD');
+      expect(dataItem.meta).to.be.an('object').that.has.any.key('advertiserDomains');
     });
     it('Should return an empty array if invalid banner response is passed', function () {
       const invBanner = {

package/test/spec/modules/mobianRtdProvider_spec.js

@@ -0,0 +1,107 @@
+import { expect } from 'chai';
+import sinon from 'sinon';
+import { mobianBrandSafetySubmodule, MOBIAN_URL } from 'modules/mobianRtdProvider.js';
+import * as ajax from 'src/ajax.js';
+
+describe('Mobian RTD Submodule', function () {
+  let ajaxStub;
+  let bidReqConfig;
+
+  beforeEach(function () {
+    bidReqConfig = {
+      ortb2Fragments: {
+        global: {
+          site: {
+            ext: {
+              data: {}
+            }
+          }
+        }
+      }
+    };
+  });
+
+  afterEach(function () {
+    ajaxStub.restore();
+  });
+
+  it('should return no_risk when server responds with garm_no_risk', function () {
+    ajaxStub = sinon.stub(ajax, 'ajaxBuilder').returns(function(url, callbacks) {
+      callbacks.success({
+        garm_no_risk: true,
+        garm_low_risk: false,
+        garm_medium_risk: false,
+        garm_high_risk: false
+      });
+    });
+
+    return mobianBrandSafetySubmodule.getBidRequestData(bidReqConfig, {}, {}).then((risk) => {
+      expect(risk).to.have.property('mobianGarmRisk');
+      expect(risk['mobianGarmRisk']).to.equal('no_risk');
+      expect(bidReqConfig.ortb2Fragments.global.site.ext.data.mobian).to.deep.equal(risk);
+    });
+  });
+
+  it('should return low_risk when server responds with garm_no_risk', function () {
+    ajaxStub = sinon.stub(ajax, 'ajaxBuilder').returns(function(url, callbacks) {
+      callbacks.success({
+        garm_no_risk: false,
+        garm_low_risk: true,
+        garm_medium_risk: false,
+        garm_high_risk: false
+      });
+    });
+
+    return mobianBrandSafetySubmodule.getBidRequestData(bidReqConfig, {}, {}).then((risk) => {
+      expect(risk).to.have.property('mobianGarmRisk');
+      expect(risk['mobianGarmRisk']).to.equal('low_risk');
+      expect(bidReqConfig.ortb2Fragments.global.site.ext.data.mobian).to.deep.equal(risk);
+    });
+  });
+
+  it('should return medium_risk when server responds with garm_medium_risk', function () {
+    ajaxStub = sinon.stub(ajax, 'ajaxBuilder').returns(function(url, callbacks) {
+      callbacks.success({
+        garm_no_risk: false,
+        garm_low_risk: false,
+        garm_medium_risk: true,
+        garm_high_risk: false
+      });
+    });
+
+    return mobianBrandSafetySubmodule.getBidRequestData(bidReqConfig, {}, {}).then((risk) => {
+      expect(risk).to.have.property('mobianGarmRisk');
+      expect(risk['mobianGarmRisk']).to.equal('medium_risk');
+      expect(bidReqConfig.ortb2Fragments.global.site.ext.data.mobian).to.deep.equal(risk);
+    });
+  });
+
+  it('should return high_risk when server responds with garm_high_risk', function () {
+    ajaxStub = sinon.stub(ajax, 'ajaxBuilder').returns(function(url, callbacks) {
+      callbacks.success({
+        garm_no_risk: false,
+        garm_low_risk: false,
+        garm_medium_risk: false,
+        garm_high_risk: true
+      });
+    });
+
+    return mobianBrandSafetySubmodule.getBidRequestData(bidReqConfig, {}, {}).then((risk) => {
+      expect(risk).to.have.property('mobianGarmRisk');
+      expect(risk['mobianGarmRisk']).to.equal('high_risk');
+      expect(bidReqConfig.ortb2Fragments.global.site.ext.data.mobian).to.deep.equal(risk);
+    });
+  });
+
+  it('should return unknown when server response is not of the expected shape', function () {
+    ajaxStub = sinon.stub(ajax, 'ajaxBuilder').returns(function(url, callbacks) {
+      callbacks.success('unexpected output not even of the right type');
+    });
+
+    return mobianBrandSafetySubmodule.getBidRequestData(bidReqConfig, {}, {}).then((risk) => {
+      expect(risk).to.have.property('mobianGarmRisk');
+      expect(risk['mobianGarmRisk']).to.equal('unknown');
+      expect(bidReqConfig.ortb2Fragments.global.site.ext.data.mobian).to.deep.equal(risk);
+    });
+  });
+});