prebid.js 7.35.0 → 7.37.0

package/test/spec/modules/minutemediaplusBidAdapter_spec.js

@@ -0,0 +1,519 @@
+import { expect } from 'chai';
+import {
+  spec as adapter,
+  SUPPORTED_ID_SYSTEMS,
+  createDomain,
+  hashCode,
+  extractPID,
+  extractCID,
+  extractSubDomain,
+  getStorageItem,
+  setStorageItem,
+  tryParseJSON,
+  getUniqueDealId,
+} from 'modules/minutemediaplusBidAdapter.js';
+import * as utils from 'src/utils.js';
+import { version } from 'package.json';
+import { useFakeTimers } from 'sinon';
+import { BANNER, VIDEO } from '../../../src/mediaTypes';
+
+const SUB_DOMAIN = 'exchange';
+
+const BID = {
+  'bidId': '2d52001cabd527',
+  'adUnitCode': 'div-gpt-ad-12345-0',
+  'params': {
+    'subDomain': SUB_DOMAIN,
+    'cId': '59db6b3b4ffaa70004f45cdc',
+    'pId': '59ac17c192832d0011283fe3',
+    'bidFloor': 0.1,
+    'ext': {
+      'param1': 'loremipsum',
+      'param2': 'dolorsitamet'
+    }
+  },
+  'placementCode': 'div-gpt-ad-1460505748561-0',
+  'transactionId': 'c881914b-a3b5-4ecf-ad9c-1c2f37c6aabf',
+  'sizes': [[300, 250], [300, 600]],
+  'bidderRequestId': '1fdb5ff1b6eaa7',
+  'requestId': 'b0777d85-d061-450e-9bc7-260dd54bbb7a',
+  'schain': 'a0819c69-005b-41ed-af06-1be1e0aefefc',
+  'mediaTypes': [BANNER]
+};
+
+const VIDEO_BID = {
+  'bidId': '2d52001cabd527',
+  'adUnitCode': '63550ad1ff6642d368cba59dh5884270560',
+  'bidderRequestId': '12a8ae9ada9c13',
+  'transactionId': '56e184c6-bde9-497b-b9b9-cf47a61381ee',
+  'schain': 'a0819c69-005b-41ed-af06-1be1e0aefefc',
+  'params': {
+    'subDomain': SUB_DOMAIN,
+    'cId': '635509f7ff6642d368cb9837',
+    'pId': '59ac17c192832d0011283fe3',
+    'bidFloor': 0.1
+  },
+  'sizes': [[545, 307]],
+  'mediaTypes': {
+    'video': {
+      'playerSize': [[545, 307]],
+      'context': 'instream',
+      'mimes': [
+        'video/mp4',
+        'application/javascript'
+      ],
+      'protocols': [2, 3, 5, 6],
+      'maxduration': 60,
+      'minduration': 0,
+      'startdelay': 0,
+      'linearity': 1,
+      'api': [2],
+      'placement': 1
+    }
+  }
+}
+
+const BIDDER_REQUEST = {
+  'gdprConsent': {
+    'consentString': 'consent_string',
+    'gdprApplies': true
+  },
+  'uspConsent': 'consent_string',
+  'refererInfo': {
+    'page': 'https://www.greatsite.com',
+    'ref': 'https://www.somereferrer.com'
+  }
+};
+
+const SERVER_RESPONSE = {
+  body: {
+    cid: 'testcid123',
+    results: [{
+      'ad': '<iframe>console.log("hello world")</iframe>',
+      'price': 0.8,
+      'creativeId': '12610997325162499419',
+      'exp': 30,
+      'width': 300,
+      'height': 250,
+      'advertiserDomains': ['securepubads.g.doubleclick.net'],
+      'cookies': [{
+        'src': 'https://sync.com',
+        'type': 'iframe'
+      }, {
+        'src': 'https://sync.com',
+        'type': 'img'
+      }]
+    }]
+  }
+};
+
+const VIDEO_SERVER_RESPONSE = {
+  body: {
+    'cid': '635509f7ff6642d368cb9837',
+    'results': [{
+      'ad': '<VAST version=\"3.0\" xmlns:xs=\"http://www.w3.org/2001/XMLSchema\"></VAST>',
+      'advertiserDomains': ['minutemedia-prebid.com'],
+      'exp': 60,
+      'width': 545,
+      'height': 307,
+      'mediaType': 'video',
+      'creativeId': '12610997325162499419',
+      'price': 2,
+      'cookies': []
+    }]
+  }
+};
+
+const REQUEST = {
+  data: {
+    width: 300,
+    height: 250,
+    bidId: '2d52001cabd527'
+  }
+};
+
+function getTopWindowQueryParams() {
+  try {
+    const parsedUrl = utils.parseUrl(window.top.document.URL, { decodeSearchAsString: true });
+    return parsedUrl.search;
+  } catch (e) {
+    return '';
+  }
+}
+
+describe('MinuteMediaPlus Bid Adapter', function () {
+  describe('validtae spec', function () {
+    it('exists and is a function', function () {
+      expect(adapter.isBidRequestValid).to.exist.and.to.be.a('function');
+    });
+
+    it('exists and is a function', function () {
+      expect(adapter.buildRequests).to.exist.and.to.be.a('function');
+    });
+
+    it('exists and is a function', function () {
+      expect(adapter.interpretResponse).to.exist.and.to.be.a('function');
+    });
+
+    it('exists and is a function', function () {
+      expect(adapter.getUserSyncs).to.exist.and.to.be.a('function');
+    });
+
+    it('exists and is a string', function () {
+      expect(adapter.code).to.exist.and.to.be.a('string');
+    });
+
+    it('exists and contains media types', function () {
+      expect(adapter.supportedMediaTypes).to.exist.and.to.be.an('array').with.length(2);
+      expect(adapter.supportedMediaTypes).to.contain.members([BANNER, VIDEO]);
+    });
+  });
+
+  describe('validate bid requests', function () {
+    it('should require cId', function () {
+      const isValid = adapter.isBidRequestValid({
+        params: {
+          pId: 'pid'
+        }
+      });
+      expect(isValid).to.be.false;
+    });
+
+    it('should require pId', function () {
+      const isValid = adapter.isBidRequestValid({
+        params: {
+          cId: 'cid'
+        }
+      });
+      expect(isValid).to.be.false;
+    });
+
+    it('should validate correctly', function () {
+      const isValid = adapter.isBidRequestValid({
+        params: {
+          cId: 'cid',
+          pId: 'pid'
+        }
+      });
+      expect(isValid).to.be.true;
+    });
+  });
+
+  describe('build requests', function () {
+    let sandbox;
+    before(function () {
+      $$PREBID_GLOBAL$$.bidderSettings = {
+        mmplus: {
+          storageAllowed: true
+        }
+      };
+      sandbox = sinon.sandbox.create();
+      sandbox.stub(Date, 'now').returns(1000);
+    });
+
+    it('should build video request', function () {
+      const hashUrl = hashCode(BIDDER_REQUEST.refererInfo.page);
+      const requests = adapter.buildRequests([VIDEO_BID], BIDDER_REQUEST);
+      expect(requests).to.have.length(1);
+      expect(requests[0]).to.deep.equal({
+        method: 'POST',
+        url: `${createDomain(SUB_DOMAIN)}/prebid/multi/635509f7ff6642d368cb9837`,
+        data: {
+          adUnitCode: '63550ad1ff6642d368cba59dh5884270560',
+          bidFloor: 0.1,
+          bidId: '2d52001cabd527',
+          bidderVersion: adapter.version,
+          cb: 1000,
+          gdpr: 1,
+          gdprConsent: 'consent_string',
+          usPrivacy: 'consent_string',
+          prebidVersion: version,
+          publisherId: '59ac17c192832d0011283fe3',
+          url: 'https%3A%2F%2Fwww.greatsite.com',
+          referrer: 'https://www.somereferrer.com',
+          res: `${window.top.screen.width}x${window.top.screen.height}`,
+          schain: VIDEO_BID.schain,
+          sizes: ['545x307'],
+          uniqueDealId: `${hashUrl}_${Date.now().toString()}`,
+          uqs: getTopWindowQueryParams(),
+          mediaTypes: {
+            video: {
+              api: [2],
+              context: 'instream',
+              linearity: 1,
+              maxduration: 60,
+              mimes: [
+                'video/mp4',
+                'application/javascript'
+              ],
+              minduration: 0,
+              placement: 1,
+              playerSize: [[545, 307]],
+              protocols: [2, 3, 5, 6],
+              startdelay: 0
+            }
+          }
+        }
+      });
+    });
+
+    it('should build banner request for each size', function () {
+      const hashUrl = hashCode(BIDDER_REQUEST.refererInfo.page);
+      const requests = adapter.buildRequests([BID], BIDDER_REQUEST);
+      expect(requests).to.have.length(1);
+      expect(requests[0]).to.deep.equal({
+        method: 'POST',
+        url: `${createDomain(SUB_DOMAIN)}/prebid/multi/59db6b3b4ffaa70004f45cdc`,
+        data: {
+          gdprConsent: 'consent_string',
+          gdpr: 1,
+          usPrivacy: 'consent_string',
+          sizes: ['300x250', '300x600'],
+          url: 'https%3A%2F%2Fwww.greatsite.com',
+          referrer: 'https://www.somereferrer.com',
+          cb: 1000,
+          bidFloor: 0.1,
+          bidId: '2d52001cabd527',
+          adUnitCode: 'div-gpt-ad-12345-0',
+          publisherId: '59ac17c192832d0011283fe3',
+          uniqueDealId: `${hashUrl}_${Date.now().toString()}`,
+          bidderVersion: adapter.version,
+          prebidVersion: version,
+          schain: BID.schain,
+          res: `${window.top.screen.width}x${window.top.screen.height}`,
+          mediaTypes: [BANNER],
+          uqs: getTopWindowQueryParams(),
+          'ext.param1': 'loremipsum',
+          'ext.param2': 'dolorsitamet',
+        }
+      });
+    });
+
+    after(function () {
+      $$PREBID_GLOBAL$$.bidderSettings = {};
+      sandbox.restore();
+    });
+  });
+  describe('getUserSyncs', function () {
+    it('should have valid user sync with iframeEnabled', function () {
+      const result = adapter.getUserSyncs({ iframeEnabled: true }, [SERVER_RESPONSE]);
+
+      expect(result).to.deep.equal([{
+        type: 'iframe',
+        url: 'https://sync.minutemedia-prebid.com/api/sync/iframe/?cid=testcid123&gdpr=0&gdpr_consent=&us_privacy='
+      }]);
+    });
+
+    it('should have valid user sync with cid on response', function () {
+      const result = adapter.getUserSyncs({ iframeEnabled: true }, [SERVER_RESPONSE]);
+      expect(result).to.deep.equal([{
+        type: 'iframe',
+        url: 'https://sync.minutemedia-prebid.com/api/sync/iframe/?cid=testcid123&gdpr=0&gdpr_consent=&us_privacy='
+      }]);
+    });
+
+    it('should have valid user sync with pixelEnabled', function () {
+      const result = adapter.getUserSyncs({ pixelEnabled: true }, [SERVER_RESPONSE]);
+
+      expect(result).to.deep.equal([{
+        'url': 'https://sync.minutemedia-prebid.com/api/sync/image/?cid=testcid123&gdpr=0&gdpr_consent=&us_privacy=',
+        'type': 'image'
+      }]);
+    })
+  });
+
+  describe('interpret response', function () {
+    it('should return empty array when there is no response', function () {
+      const responses = adapter.interpretResponse(null);
+      expect(responses).to.be.empty;
+    });
+
+    it('should return empty array when there is no ad', function () {
+      const responses = adapter.interpretResponse({ price: 1, ad: '' });
+      expect(responses).to.be.empty;
+    });
+
+    it('should return empty array when there is no price', function () {
+      const responses = adapter.interpretResponse({ price: null, ad: 'great ad' });
+      expect(responses).to.be.empty;
+    });
+
+    it('should return an array of interpreted banner responses', function () {
+      const responses = adapter.interpretResponse(SERVER_RESPONSE, REQUEST);
+      expect(responses).to.have.length(1);
+      expect(responses[0]).to.deep.equal({
+        requestId: '2d52001cabd527',
+        cpm: 0.8,
+        width: 300,
+        height: 250,
+        creativeId: '12610997325162499419',
+        currency: 'USD',
+        netRevenue: true,
+        ttl: 30,
+        ad: '<iframe>console.log("hello world")</iframe>',
+        meta: {
+          advertiserDomains: ['securepubads.g.doubleclick.net']
+        }
+      });
+    });
+
+    it('should return an array of interpreted video responses', function () {
+      const responses = adapter.interpretResponse(VIDEO_SERVER_RESPONSE, REQUEST);
+      expect(responses).to.have.length(1);
+      expect(responses[0]).to.deep.equal({
+        requestId: '2d52001cabd527',
+        cpm: 2,
+        width: 545,
+        height: 307,
+        mediaType: 'video',
+        creativeId: '12610997325162499419',
+        currency: 'USD',
+        netRevenue: true,
+        ttl: 60,
+        vastXml: '<VAST version=\"3.0\" xmlns:xs=\"http://www.w3.org/2001/XMLSchema\"></VAST>',
+        meta: {
+          advertiserDomains: ['minutemedia-prebid.com']
+        }
+      });
+    });
+
+    it('should take default TTL', function () {
+      const serverResponse = utils.deepClone(SERVER_RESPONSE);
+      delete serverResponse.body.results[0].exp;
+      const responses = adapter.interpretResponse(serverResponse, REQUEST);
+      expect(responses).to.have.length(1);
+      expect(responses[0].ttl).to.equal(300);
+    });
+  });
+
+  describe('user id system', function () {
+    Object.keys(SUPPORTED_ID_SYSTEMS).forEach((idSystemProvider) => {
+      const id = Date.now().toString();
+      const bid = utils.deepClone(BID);
+
+      const userId = (function () {
+        switch (idSystemProvider) {
+          case 'lipb':
+            return { lipbid: id };
+          case 'parrableId':
+            return { eid: id };
+          case 'id5id':
+            return { uid: id };
+          default:
+            return id;
+        }
+      })();
+
+      bid.userId = {
+        [idSystemProvider]: userId
+      };
+
+      it(`should include 'uid.${idSystemProvider}' in request params`, function () {
+        const requests = adapter.buildRequests([bid], BIDDER_REQUEST);
+        expect(requests[0].data[`uid.${idSystemProvider}`]).to.equal(id);
+      });
+    });
+  });
+
+  describe('alternate param names extractors', function () {
+    it('should return undefined when param not supported', function () {
+      const cid = extractCID({ 'c_id': '1' });
+      const pid = extractPID({ 'p_id': '1' });
+      const subDomain = extractSubDomain({ 'sub_domain': 'prebid' });
+      expect(cid).to.be.undefined;
+      expect(pid).to.be.undefined;
+      expect(subDomain).to.be.undefined;
+    });
+
+    it('should return value when param supported', function () {
+      const cid = extractCID({ 'cID': '1' });
+      const pid = extractPID({ 'Pid': '2' });
+      const subDomain = extractSubDomain({ 'subDOMAIN': 'prebid' });
+      expect(cid).to.be.equal('1');
+      expect(pid).to.be.equal('2');
+      expect(subDomain).to.be.equal('prebid');
+    });
+  });
+
+  describe('unique deal id', function () {
+    before(function () {
+      $$PREBID_GLOBAL$$.bidderSettings = {
+        mmplus: {
+          storageAllowed: true
+        }
+      };
+    });
+    after(function () {
+      $$PREBID_GLOBAL$$.bidderSettings = {};
+    });
+    const key = 'myKey';
+    let uniqueDealId;
+    beforeEach(() => {
+      uniqueDealId = getUniqueDealId(key, 0);
+    })
+
+    it('should get current unique deal id', function (done) {
+      // waiting some time so `now` will become past
+      setTimeout(() => {
+        const current = getUniqueDealId(key);
+        expect(current).to.be.equal(uniqueDealId);
+        done();
+      }, 200);
+    });
+
+    it('should get new unique deal id on expiration', function (done) {
+      setTimeout(() => {
+        const current = getUniqueDealId(key, 100);
+        expect(current).to.not.be.equal(uniqueDealId);
+        done();
+      }, 200)
+    });
+  });
+
+  describe('storage utils', function () {
+    before(function () {
+      $$PREBID_GLOBAL$$.bidderSettings = {
+        mmplus: {
+          storageAllowed: true
+        }
+      };
+    });
+    after(function () {
+      $$PREBID_GLOBAL$$.bidderSettings = {};
+    });
+    it('should get value from storage with create param', function () {
+      const now = Date.now();
+      const clock = useFakeTimers({
+        shouldAdvanceTime: true,
+        now
+      });
+      setStorageItem('myKey', 2020);
+      const { value, created } = getStorageItem('myKey');
+      expect(created).to.be.equal(now);
+      expect(value).to.be.equal(2020);
+      expect(typeof value).to.be.equal('number');
+      expect(typeof created).to.be.equal('number');
+      clock.restore();
+    });
+
+    it('should get external stored value', function () {
+      const value = 'superman'
+      window.localStorage.setItem('myExternalKey', value);
+      const item = getStorageItem('myExternalKey');
+      expect(item).to.be.equal(value);
+    });
+
+    it('should parse JSON value', function () {
+      const data = JSON.stringify({ event: 'send' });
+      const { event } = tryParseJSON(data);
+      expect(event).to.be.equal('send');
+    });
+
+    it('should get original value on parse fail', function () {
+      const value = 21;
+      const parsed = tryParseJSON(value);
+      expect(typeof parsed).to.be.equal('number');
+      expect(parsed).to.be.equal(value);
+    });
+  });
+});

package/test/spec/modules/neuwoRtdProvider_spec.js

@@ -0,0 +1,123 @@
+import { server } from 'test/mocks/xhr.js';
+import * as neuwo from 'modules/neuwoRtdProvider';
+
+const PUBLIC_TOKEN = 'public_key_0000';
+const config = () => ({
+  params: {
+    publicToken: PUBLIC_TOKEN
+  }
+})
+
+const apiReturns = () => ({
+  somethingExtra: { object: true },
+  marketing_categories: {
+    iab_tier_1: [
+      { ID: 'IAB21', label: 'Real Estate', relevance: '0.45699' }
+    ]
+  }
+})
+
+const TAX_ID = '441'
+
+/**
+ * Object generator, like above, written using alternative techniques
+ * @returns object with predefined (expected) bidsConfig fields
+ */
+function bidsConfiglike() {
+  return Object.assign({}, {
+    ortb2Fragments: { global: {} }
+  })
+}
+
+describe('neuwoRtdProvider', function () {
+  describe('neuwoRtdModule', function () {
+    it('initializes', function () {
+      expect(neuwo.neuwoRtdModule.init(config())).to.be.true;
+    })
+    it('init needs that public token', function () {
+      expect(neuwo.neuwoRtdModule.init()).to.be.false;
+    })
+
+    describe('segment picking', function () {
+      it('handles bad inputs', function () {
+        expect(neuwo.pickSegments()).to.be.an('array').that.is.empty;
+        expect(neuwo.pickSegments('technically also an array')).to.be.an('array').that.is.empty;
+        expect(neuwo.pickSegments({ bad_object: 'bad' })).to.be.an('array').that.is.empty;
+      })
+      it('handles malformations', function () {
+        let result = neuwo.pickSegments([{something_wrong: true}, null, { ID: 'IAB19-20' }, { id: 'IAB3-1', ID: 'IAB9-20' }])
+        expect(result[0].id).to.equal('631')
+        expect(result[1].id).to.equal('58')
+        expect(result.length).to.equal(2)
+      })
+    })
+
+    describe('topic injection', function () {
+      it('mutates bidsConfig', function () {
+        let topics = apiReturns()
+        let bidsConfig = bidsConfiglike()
+        neuwo.injectTopics(topics, bidsConfig, () => { })
+        expect(bidsConfig.ortb2Fragments.global.site.content.data[0].name, 'name of first content data object').to.equal(neuwo.DATA_PROVIDER)
+        expect(bidsConfig.ortb2Fragments.global.site.content.data[0].segment[0].id, 'id of first segment in content.data').to.equal(TAX_ID)
+        expect(bidsConfig.ortb2Fragments.global.site.cattax, 'category taxonomy code for pagecat').to.equal(6) // CATTAX_IAB
+        expect(bidsConfig.ortb2Fragments.global.site.pagecat[0], 'category taxonomy code for pagecat').to.equal(TAX_ID)
+      })
+
+      it('handles malformed responses', function () {
+        let topics = { message: 'Forbidden' }
+        let bidsConfig = bidsConfiglike()
+        neuwo.injectTopics(topics, bidsConfig, () => { })
+        expect(bidsConfig.ortb2Fragments.global.site.content.data[0].name, 'name of first content data object').to.equal(neuwo.DATA_PROVIDER)
+        expect(bidsConfig.ortb2Fragments.global.site.content.data[0].segment, 'length of segment(s) in content.data').to.be.an('array').that.is.empty;
+
+        topics = '404 wouldn\'t really even show up for injection'
+        let bdsConfig = bidsConfiglike()
+        neuwo.injectTopics(topics, bdsConfig, () => { })
+        expect(bdsConfig.ortb2Fragments.global.site.content.data[0].name, 'name of first content data object').to.equal(neuwo.DATA_PROVIDER)
+        expect(bdsConfig.ortb2Fragments.global.site.content.data[0].segment, 'length of segment(s) in content.data').to.be.an('array').that.is.empty;
+
+        topics = undefined
+        let bdsConfigE = bidsConfiglike()
+        neuwo.injectTopics(topics, bdsConfigE, () => { })
+        expect(bdsConfigE.ortb2Fragments.global.site.content.data[0].name, 'name of first content data object').to.equal(neuwo.DATA_PROVIDER)
+        expect(bdsConfigE.ortb2Fragments.global.site.content.data[0].segment, 'length of segment(s) in content.data').to.be.an('array').that.is.empty;
+      })
+    })
+
+    describe('fragment addition', function () {
+      it('mutates input objects', function () {
+        let alphabet = { a: { b: { c: {} } } }
+        neuwo.addFragment(alphabet.a.b.c, 'd.e.f', { g: 'h' })
+        expect(alphabet.a.b.c.d.e.f.g).to.equal('h')
+      })
+    })
+
+    describe('getBidRequestData', function () {
+      it('forms requests properly and mutates input bidsConfig', function () {
+        let bids = bidsConfiglike()
+        let conf = config()
+        // control xhr api request target for testing
+        conf.params.argUrl = 'https://publisher.works/article.php?get=horrible_url_for_testing&id=5'
+
+        neuwo.getBidRequestData(bids, () => { }, conf, 'any consent data works, clearly')
+
+        let request = server.requests[0];
+        expect(request.url).to.be.a('string').that.includes(conf.params.publicToken)
+        expect(request.url).to.include(encodeURIComponent(conf.params.argUrl))
+        request.respond(200, { 'Content-Type': 'application/json; encoding=UTF-8' }, JSON.stringify(apiReturns()));
+
+        expect(bids.ortb2Fragments.global.site.content.data[0].name, 'name of first content data object').to.equal(neuwo.DATA_PROVIDER)
+        expect(bids.ortb2Fragments.global.site.content.data[0].segment[0].id, 'id of first segment in content.data').to.equal(TAX_ID)
+      })
+
+      it('accepts detail not available result', function () {
+        let bidsConfig = bidsConfiglike()
+        let comparison = bidsConfiglike()
+        neuwo.getBidRequestData(bidsConfig, () => { }, config(), 'consensually')
+        let request = server.requests[0];
+        request.respond(404, { 'Content-Type': 'application/json; encoding=UTF-8' }, JSON.stringify({ detail: 'Basically first time seeing this' }));
+        expect(bidsConfig).to.deep.equal(comparison)
+      })
+    })
+  })
+})

package/test/spec/modules/nextMillenniumBidAdapter_spec.js

@@ -142,6 +142,17 @@ describe('nextMillenniumBidAdapterTests', function() {
     expect(userSync[0].url).to.equal('urlB');
   });
 
+  it('Test getUserSyncs with no response', function () {
+    const syncOptions = {
+      'iframeEnabled': true,
+      'pixelEnabled': false
+    }
+    let userSync = spec.getUserSyncs(syncOptions, [], bidRequestData[0].gdprConsent, bidRequestData[0].uspConsent);
+    expect(userSync).to.be.an('array')
+    expect(userSync[0].type).to.equal('iframe')
+    expect(userSync[0].url).to.equal('https://cookies.nextmillmedia.com/sync?gdpr=1&gdpr_consent=kjfdniwjnifwenrif3&us_privacy=1---&type=iframe')
+  })
+
   it('Test getUserSyncs function if GDPR is undefined', function () {
     const syncOptions = {
       'iframeEnabled': false,