prebid.js 7.22.0 → 7.24.0

package/test/spec/modules/kueezRtbBidAdapter_spec.js

@@ -0,0 +1,396 @@
+import {expect} from 'chai';
+import {
+  spec as adapter,
+  SUPPORTED_ID_SYSTEMS,
+  createDomain,
+  hashCode,
+  extractPID,
+  extractCID,
+  extractSubDomain,
+  getStorageItem,
+  setStorageItem,
+  tryParseJSON,
+  getUniqueDealId,
+} from 'modules/kueezRtbBidAdapter.js';
+import * as utils from 'src/utils.js';
+import {version} from 'package.json';
+import {useFakeTimers} from 'sinon';
+
+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'
+};
+
+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 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('KueezRtbBidAdapter', 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');
+    });
+  });
+
+  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 = {
+        kueezrtb: {
+          storageAllowed: true
+        }
+      };
+      sandbox = sinon.sandbox.create();
+      sandbox.stub(Date, 'now').returns(1000);
+    });
+
+    it('should build 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}`,
+          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.kueezrtb.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.kueezrtb.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.kueezrtb.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 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 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 = {
+        kueezrtb: {
+          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 = {
+        kueezrtb: {
+          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/magniteAnalyticsAdapter_spec.js

@@ -602,6 +602,32 @@ describe('magnite analytics adapter', function () {
         let message = JSON.parse(server.requests[0].requestBody);
         expect(message.auctions[0].adUnits[0].bids[0].bidResponse.adomains).to.deep.equal(test.expected);
       });
+
+      // Network Id tests
+      [
+        { input: 'magnite.com', expected: 'magnite.com' },
+        { input: 12345, expected: '12345' },
+        { input: ['magnite.com', 12345], expected: 'magnite.com,12345' }
+      ].forEach((test, index) => {
+        it(`should handle networkId correctly - #${index + 1}`, function () {
+          events.emit(AUCTION_INIT, MOCK.AUCTION_INIT);
+          events.emit(BID_REQUESTED, MOCK.BID_REQUESTED);
+
+          let bidResponse = utils.deepClone(MOCK.BID_RESPONSE);
+          bidResponse.meta = {
+            networkId: test.input
+          };
+
+          events.emit(BID_RESPONSE, bidResponse);
+          events.emit(BIDDER_DONE, MOCK.BIDDER_DONE);
+          events.emit(AUCTION_END, MOCK.AUCTION_END);
+          events.emit(BID_WON, MOCK.BID_WON);
+          clock.tick(rubiConf.analyticsBatchTimeout + 1000);
+
+          let message = JSON.parse(server.requests[0].requestBody);
+          expect(message.auctions[0].adUnits[0].bids[0].bidResponse.networkId).to.equal(test.expected);
+        });
+      });
     });
 
     describe('with session handling', function () {