prebid.js 8.6.0 → 8.8.0

package/test/spec/modules/connatixBidAdapter_spec.js

@@ -0,0 +1,366 @@
+import { expect } from 'chai';
+import {
+  spec,
+  getBidFloor as connatixGetBidFloor
+} from '../../../modules/connatixBidAdapter.js';
+import { BANNER } from '../../../src/mediaTypes.js';
+
+describe('connatixBidAdapter', function () {
+  let bid;
+
+  function mockBidRequest() {
+    const mediaTypes = {
+      banner: {
+        sizes: [16, 9],
+      }
+    };
+    return {
+      bidId: 'testing',
+      bidder: 'connatix',
+      params: {
+        placementId: '30e91414-545c-4f45-a950-0bec9308ff22'
+      },
+      mediaTypes
+    };
+  };
+
+  describe('isBidRequestValid', function () {
+    this.beforeEach(function () {
+      bid = mockBidRequest();
+    });
+
+    it('Should return true if all required fileds are present', function () {
+      expect(spec.isBidRequestValid(bid)).to.be.true;
+    });
+    it('Should return false if bidder does not correspond', function () {
+      bid.bidder = 'abc';
+      expect(spec.isBidRequestValid(bid)).to.be.false;
+    });
+    it('Should return false if bidId is missing', function () {
+      delete bid.bidId;
+      expect(spec.isBidRequestValid(bid)).to.be.false;
+    });
+    it('Should return false if params object is missing', function () {
+      delete bid.params;
+      expect(spec.isBidRequestValid(bid)).to.be.false;
+    });
+    it('Should return false if placementId is missing from params', function () {
+      delete bid.params.placementId;
+      expect(spec.isBidRequestValid(bid)).to.be.false;
+    });
+    it('Should return false if mediaTypes is missing', function () {
+      delete bid.mediaTypes;
+      expect(spec.isBidRequestValid(bid)).to.be.false;
+    });
+    it('Should return false if banner is missing from mediaTypes ', function () {
+      delete bid.mediaTypes.banner;
+      expect(spec.isBidRequestValid(bid)).to.be.false;
+    });
+    it('Should return false if sizes is missing from banner object', function () {
+      delete bid.mediaTypes.banner.sizes;
+      expect(spec.isBidRequestValid(bid)).to.be.false;
+    });
+    it('Should return false if sizes is not an array', function () {
+      bid.mediaTypes.banner.sizes = 'test';
+      expect(spec.isBidRequestValid(bid)).to.be.false;
+    });
+    it('Should return false if sizes is an empty array', function () {
+      bid.mediaTypes.banner.sizes = [];
+      expect(spec.isBidRequestValid(bid)).to.be.false;
+    });
+    it('Should return true if add an extra field was added to the bidRequest', function () {
+      bid.params.test = 1;
+      expect(spec.isBidRequestValid(bid)).to.be.true;
+    });
+  });
+
+  describe('buildRequests', function () {
+    let serverRequest;
+    let bidderRequest = {
+      refererInfo: {
+        canonicalUrl: '',
+        numIframes: 0,
+        reachedTop: true,
+        referer: 'http://example.com',
+        stack: ['http://example.com']
+      },
+      gdprConsent: {
+        consentString: 'BOJ/P2HOJ/P2HABABMAAAAAZ+A==',
+        vendorData: {},
+        gdprApplies: true
+      },
+      uspConsent: '1YYY',
+      ortb2: {
+        site: {
+          data: {
+            pageType: 'article'
+          }
+        }
+      }
+    };
+
+    this.beforeEach(function () {
+      bid = mockBidRequest();
+      serverRequest = spec.buildRequests([bid], 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://capi.connatix.com/rtb/hba');
+    });
+    it('Returns request payload', function () {
+      expect(serverRequest.data).to.not.empty;
+    });
+    it('Validate request payload', function () {
+      expect(serverRequest.data.bidRequests[0].bidId).to.equal(bid.bidId);
+      expect(serverRequest.data.bidRequests[0].placementId).to.equal(bid.params.placementId);
+      expect(serverRequest.data.bidRequests[0].floor).to.equal(0);
+      expect(serverRequest.data.bidRequests[0].mediaTypes).to.equal(bid.mediaTypes);
+      expect(serverRequest.data.bidRequests[0].sizes).to.equal(bid.mediaTypes.sizes);
+      expect(serverRequest.data.refererInfo).to.equal(bidderRequest.refererInfo);
+      expect(serverRequest.data.gdprConsent).to.equal(bidderRequest.gdprConsent);
+      expect(serverRequest.data.uspConsent).to.equal(bidderRequest.uspConsent);
+      expect(serverRequest.data.ortb2).to.equal(bidderRequest.ortb2);
+    });
+  });
+
+  describe('interpretResponse', function () {
+    const CustomerId = '99f20d18-c4b4-4a28-3d8e-d43e2c8cb4ac';
+    const PlayerId = 'e4984e88-9ff4-45a3-8b9d-33aabcad634f';
+    const Bid = {Cpm: 0.1, LineItems: [], RequestId: '2f897340c4eaa3', Ttl: 86400};
+
+    let serverResponse;
+    this.beforeEach(function () {
+      serverResponse = {
+        body: {
+          CustomerId,
+          PlayerId,
+          Bids: [ Bid ]
+        },
+        headers: function() { }
+      };
+    });
+
+    it('Should return an empty array if Bids is null', function () {
+      serverResponse.body.Bids = null;
+
+      const response = spec.interpretResponse(serverResponse);
+      expect(response).to.be.an('array').that.is.empty;
+    });
+
+    it('Should return an empty array if Bids is empty array', function () {
+      serverResponse.body.Bids = [];
+      const response = spec.interpretResponse(serverResponse);
+      expect(response).to.be.an('array').that.is.empty;
+    });
+
+    it('Should return an empty array if CustomerId is null', function () {
+      serverResponse.body.CustomerId = null;
+      const response = spec.interpretResponse(serverResponse);
+      expect(response).to.be.an('array').that.is.empty;
+    });
+
+    it('Should return an empty array if PlayerId is null', function () {
+      serverResponse.body.PlayerId = null;
+      const response = spec.interpretResponse(serverResponse);
+      expect(response).to.be.an('array').that.is.empty;
+    });
+
+    it('Should return one bid response for one bid', function() {
+      const bidResponses = spec.interpretResponse(serverResponse);
+      expect(bidResponses.length).to.equal(1);
+    });
+
+    it('Should contains the same values as in the serverResponse', function() {
+      const bidResponses = spec.interpretResponse(serverResponse);
+
+      const [ bidResponse ] = bidResponses;
+      expect(bidResponse.requestId).to.equal(serverResponse.body.Bids[0].RequestId);
+      expect(bidResponse.cpm).to.equal(serverResponse.body.Bids[0].Cpm);
+      expect(bidResponse.ttl).to.equal(serverResponse.body.Bids[0].Ttl);
+      expect(bidResponse.currency).to.equal('USD');
+      expect(bidResponse.mediaType).to.equal(BANNER);
+      expect(bidResponse.netRevenue).to.be.true;
+    });
+
+    it('Should return n bid responses for n bids', function() {
+      serverResponse.body.Bids = [ { ...Bid }, { ...Bid } ];
+
+      const firstBidCpm = 4;
+      serverResponse.body.Bids[0].Cpm = firstBidCpm;
+
+      const secondBidCpm = 13;
+      serverResponse.body.Bids[1].Cpm = secondBidCpm;
+
+      const bidResponses = spec.interpretResponse(serverResponse);
+      expect(bidResponses.length).to.equal(2);
+
+      expect(bidResponses[0].cpm).to.equal(firstBidCpm);
+      expect(bidResponses[1].cpm).to.equal(secondBidCpm);
+    });
+  });
+
+  describe('getUserSyncs', function() {
+    const CustomerId = '99f20d18-c4b4-4a28-3d8e-d43e2c8cb4ac';
+    const PlayerId = 'e4984e88-9ff4-45a3-8b9d-33aabcad634f';
+    const UserSyncEndpoint = 'https://connatix.com/sync'
+    const Bid = {Cpm: 0.1, LineItems: [], RequestId: '2f897340c4eaa3', Ttl: 86400};
+
+    const serverResponse = {
+      body: {
+        CustomerId,
+        PlayerId,
+        UserSyncEndpoint,
+        Bids: [ Bid ]
+      },
+      headers: function() { }
+    };
+
+    it('Should return an empty array when iframeEnabled: false', function () {
+      expect(spec.getUserSyncs({iframeEnabled: false, pixelEnabled: true}, [], {}, {}, {})).to.be.an('array').that.is.empty;
+    });
+    it('Should return an empty array when serverResponses is emprt array', function () {
+      expect(spec.getUserSyncs({iframeEnabled: true, pixelEnabled: true}, [], {}, {}, {})).to.be.an('array').that.is.empty;
+    });
+    it('Should return an empty array when iframeEnabled: true but serverResponses in an empty array', function () {
+      expect(spec.getUserSyncs({iframeEnabled: false, pixelEnabled: true}, [serverResponse], {}, {}, {})).to.be.an('array').that.is.empty;
+    });
+    it('Should return an empty array when iframeEnabled: true but serverResponses in an not defined or null', function () {
+      expect(spec.getUserSyncs({iframeEnabled: false, pixelEnabled: true}, undefined, {}, {}, {})).to.be.an('array').that.is.empty;
+      expect(spec.getUserSyncs({iframeEnabled: false, pixelEnabled: true}, null, {}, {}, {})).to.be.an('array').that.is.empty;
+    });
+    it('Should return one user sync object when iframeEnabled is true and serverResponses is not an empry array', function () {
+      expect(spec.getUserSyncs({iframeEnabled: true, pixelEnabled: true}, [serverResponse], {}, {}, {})).to.be.an('array').that.is.not.empty;
+    });
+    it('Should return a list containing a single object having type: iframe and url: syncUrl', function () {
+      const userSyncList = spec.getUserSyncs({iframeEnabled: true, pixelEnabled: true}, [serverResponse], undefined, undefined, undefined);
+      const { type, url } = userSyncList[0];
+      expect(type).to.equal('iframe');
+      expect(url).to.equal(UserSyncEndpoint);
+    });
+    it('Should append gdpr: 0 if gdprConsent object is provided but gdprApplies field is not provided', function () {
+      const userSyncList = spec.getUserSyncs(
+        {iframeEnabled: true, pixelEnabled: true},
+        [serverResponse],
+        {},
+        undefined,
+        undefined
+      );
+      const { url } = userSyncList[0];
+      expect(url).to.equal(`${UserSyncEndpoint}?gdpr=0`);
+    });
+    it('Should append gdpr having the value of gdprApplied if gdprConsent object is present and have gdprApplies field', function () {
+      const userSyncList = spec.getUserSyncs(
+        {iframeEnabled: true, pixelEnabled: true},
+        [serverResponse],
+        {gdprApplies: true},
+        undefined,
+        undefined
+      );
+      const { url } = userSyncList[0];
+      expect(url).to.equal(`${UserSyncEndpoint}?gdpr=1`);
+    });
+    it('Should append gdpr_consent if gdprConsent object is present and have gdprApplies field', function () {
+      const userSyncList = spec.getUserSyncs(
+        {iframeEnabled: true, pixelEnabled: true},
+        [serverResponse],
+        {gdprApplies: true, consentString: 'alabala'},
+        undefined,
+        undefined
+      );
+      const { url } = userSyncList[0];
+      expect(url).to.equal(`${UserSyncEndpoint}?gdpr=1&gdpr_consent=alabala`);
+    });
+    it('Should encodeURI gdpr_consent corectly', function () {
+      const userSyncList = spec.getUserSyncs(
+        {iframeEnabled: true, pixelEnabled: true},
+        [serverResponse],
+        {gdprApplies: true, consentString: 'test&2'},
+        undefined,
+        undefined
+      );
+      const { url } = userSyncList[0];
+      expect(url).to.equal(`${UserSyncEndpoint}?gdpr=1&gdpr_consent=test%262`);
+    });
+    it('Should append usp_consent to the url if uspConsent is provided', function () {
+      const userSyncList = spec.getUserSyncs(
+        {iframeEnabled: true, pixelEnabled: true},
+        [serverResponse],
+        {gdprApplies: true, consentString: 'test&2'},
+        '1YYYN',
+        undefined
+      );
+      const { url } = userSyncList[0];
+      expect(url).to.equal(`${UserSyncEndpoint}?gdpr=1&gdpr_consent=test%262&us_privacy=1YYYN`);
+    });
+    it('Should not modify the sync url if gppConsent param is provided', function () {
+      const userSyncList = spec.getUserSyncs(
+        {iframeEnabled: true, pixelEnabled: true},
+        [serverResponse],
+        {gdprApplies: true, consentString: 'test&2'},
+        '1YYYN',
+        {consent: '1'}
+      );
+      const { url } = userSyncList[0];
+      expect(url).to.equal(`${UserSyncEndpoint}?gdpr=1&gdpr_consent=test%262&us_privacy=1YYYN`);
+    });
+  });
+
+  describe('getBidFloor', function () {
+    this.beforeEach(function () {
+      bid = mockBidRequest();
+    });
+
+    it('Should return 0 if both getFloor method and bidfloor param from bid are absent.', function () {
+      const floor = connatixGetBidFloor(bid);
+      expect(floor).to.equal(0);
+    });
+
+    it('Should return the value of the bidfloor parameter if the getFloor method is not defined but the bidfloor parameter is defined', function () {
+      const floorValue = 3;
+      bid.params.bidfloor = floorValue;
+
+      const floor = connatixGetBidFloor(bid);
+      expect(floor).to.equal(floorValue);
+    });
+
+    it('Should return the value of the getFloor method if the getFloor method is defined but the bidfloor parameter is not defined', function () {
+      const floorValue = 7;
+      bid.getFloor = function() {
+        return { floor: floorValue };
+      };
+
+      const floor = connatixGetBidFloor(bid);
+      expect(floor).to.equal(floorValue);
+    });
+
+    it('Should return the value of the getFloor method if both getFloor method and bidfloor parameter are defined', function () {
+      const floorParamValue = 3;
+      bid.params.bidfloor = floorParamValue;
+
+      const floorMethodValue = 7;
+      bid.getFloor = function() {
+        return { floor: floorMethodValue };
+      };
+
+      const floor = connatixGetBidFloor(bid);
+      expect(floor).to.equal(floorMethodValue);
+    });
+
+    it('Should return 0 if the getFloor method is defined and it crash when call it', function () {
+      bid.getFloor = function() {
+        throw new Error('error');
+      };
+      const floor = connatixGetBidFloor(bid);
+      expect(floor).to.equal(0);
+    });
+  });
+});

package/test/spec/modules/criteoBidAdapter_spec.js

@@ -217,15 +217,36 @@ describe('The Criteo bidding adapter', function () {
       }
       getCookieStub.callsFake(cookieName => cookieData[cookieName]);
       setCookieStub.callsFake((cookieName, value, expires) => cookieData[cookieName] = value);
+      getDataFromLocalStorageStub.callsFake(name => lsData[name]);
       removeDataFromLocalStorageStub.callsFake(name => lsData[name] = '');
       spec.onDataDeletionRequest([]);
       expect(getCookieStub.calledOnce).to.equal(true);
       expect(setCookieStub.calledOnce).to.equal(true);
+      expect(getDataFromLocalStorageStub.calledOnce).to.equal(true);
       expect(removeDataFromLocalStorageStub.calledOnce).to.equal(true);
       expect(cookieData.cto_bundle).to.equal('');
       expect(lsData.cto_bundle).to.equal('');
       expect(ajaxStub.calledOnce).to.equal(true);
     });
+
+    it('should not call API when calling onDataDeletionRequest with no id', () => {
+      const cookieData = {
+        'cto_bundle': ''
+      };
+      const lsData = {
+        'cto_bundle': ''
+      }
+      getCookieStub.callsFake(cookieName => cookieData[cookieName]);
+      setCookieStub.callsFake((cookieName, value, expires) => cookieData[cookieName] = value);
+      getDataFromLocalStorageStub.callsFake(name => lsData[name]);
+      removeDataFromLocalStorageStub.callsFake(name => lsData[name] = '');
+      spec.onDataDeletionRequest([]);
+      expect(getCookieStub.calledOnce).to.be.true;
+      expect(setCookieStub.called).to.be.false;
+      expect(getDataFromLocalStorageStub.calledOnce).to.be.true
+      expect(removeDataFromLocalStorageStub.called).to.be.false;
+      expect(ajaxStub.called).to.be.false;
+    });
   });
 
   describe('isBidRequestValid', function () {
@@ -682,6 +703,33 @@ describe('The Criteo bidding adapter', function () {
       expect(ortbRequest.source.tid).to.equal('abc');
     });
 
+    it('should properly transmit bidId if available', function () {
+      const bidderRequest = {
+        ortb2: {
+          source: {
+            tid: 'abc'
+          }
+        }
+      };
+      const bidRequests = [
+        {
+          bidId: 'bidId',
+          bidder: 'criteo',
+          adUnitCode: 'bid-123',
+          transactionId: 'transaction-123',
+          mediaTypes: {
+            banner: {
+              sizes: [[728, 90]]
+            }
+          },
+          params: {}
+        },
+      ];
+      const request = spec.buildRequests(bidRequests, bidderRequest);
+      const ortbRequest = request.data;
+      expect(ortbRequest.slots[0].slotid).to.equal('bidId');
+    });
+
     it('should properly build a request if refererInfo is not provided', function () {
       const bidderRequest = {};
       const bidRequests = [
@@ -1865,6 +1913,11 @@ describe('The Criteo bidding adapter', function () {
         bidRequests: [{
           adUnitCode: 'test-requestId',
           bidId: 'test-bidId',
+          mediaTypes: {
+            banner: {
+              sizes: [[728, 90]]
+            }
+          },
           params: {
             networkId: 456,
           }
@@ -1883,6 +1936,202 @@ describe('The Criteo bidding adapter', function () {
       expect(bids[0].meta.networkName).to.equal('Criteo');
     });
 
+    it('should properly parse a bid response with a networkId with twin ad unit banner win', function () {
+      const response = {
+        body: {
+          slots: [{
+            impid: 'test-requestId',
+            cpm: 1.23,
+            creative: 'test-ad',
+            creativecode: 'test-crId',
+            width: 728,
+            height: 90,
+            deal: 'myDealCode',
+            adomain: ['criteo.com'],
+            ext: {
+              meta: {
+                networkName: 'Criteo'
+              }
+            }
+          }],
+        },
+      };
+      const request = {
+        bidRequests: [{
+          adUnitCode: 'test-requestId',
+          bidId: 'test-bidId',
+          mediaTypes: {
+            video: {
+              context: 'instream',
+              mimes: ['video/mpeg'],
+              playerSize: [640, 480],
+              protocols: [5, 6],
+              maxduration: 30,
+              api: [1, 2]
+            }
+          },
+          params: {
+            networkId: 456,
+          },
+        }, {
+          adUnitCode: 'test-requestId',
+          bidId: 'test-bidId2',
+          mediaTypes: {
+            banner: {
+              sizes: [[728, 90]]
+            }
+          },
+          params: {
+            networkId: 456,
+          }
+        }]
+      };
+      const bids = spec.interpretResponse(response, request);
+      expect(bids).to.have.lengthOf(1);
+      expect(bids[0].requestId).to.equal('test-bidId2');
+      expect(bids[0].cpm).to.equal(1.23);
+      expect(bids[0].ad).to.equal('test-ad');
+      expect(bids[0].creativeId).to.equal('test-crId');
+      expect(bids[0].width).to.equal(728);
+      expect(bids[0].height).to.equal(90);
+      expect(bids[0].dealId).to.equal('myDealCode');
+      expect(bids[0].meta.advertiserDomains[0]).to.equal('criteo.com');
+      expect(bids[0].meta.networkName).to.equal('Criteo');
+    });
+
+    it('should properly parse a bid response with a networkId with twin ad unit video win', function () {
+      const response = {
+        body: {
+          slots: [{
+            impid: 'test-requestId',
+            bidId: 'abc123',
+            cpm: 1.23,
+            displayurl: 'http://test-ad',
+            width: 728,
+            height: 90,
+            zoneid: 123,
+            video: true,
+            ext: {
+              meta: {
+                networkName: 'Criteo'
+              }
+            }
+          }],
+        },
+      };
+      const request = {
+        bidRequests: [{
+          adUnitCode: 'test-requestId',
+          bidId: 'test-bidId',
+          mediaTypes: {
+            video: {
+              context: 'instream',
+              mimes: ['video/mpeg'],
+              playerSize: [728, 90],
+              protocols: [5, 6],
+              maxduration: 30,
+              api: [1, 2]
+            }
+          },
+          params: {
+            networkId: 456,
+          },
+        }, {
+          adUnitCode: 'test-requestId',
+          bidId: 'test-bidId2',
+          mediaTypes: {
+            banner: {
+              sizes: [[728, 90]]
+            }
+          },
+          params: {
+            networkId: 456,
+          }
+        }]
+      };
+      const bids = spec.interpretResponse(response, request);
+      expect(bids).to.have.lengthOf(1);
+      expect(bids[0].requestId).to.equal('test-bidId');
+      expect(bids[0].cpm).to.equal(1.23);
+      expect(bids[0].vastUrl).to.equal('http://test-ad');
+      expect(bids[0].mediaType).to.equal(VIDEO);
+    });
+
+    it('should properly parse a bid response with a networkId with twin ad unit native win', function () {
+      const response = {
+        body: {
+          slots: [{
+            impid: 'test-requestId',
+            cpm: 1.23,
+            creative: 'test-ad',
+            creativecode: 'test-crId',
+            width: 728,
+            height: 90,
+            deal: 'myDealCode',
+            adomain: ['criteo.com'],
+            native: {
+              'products': [{
+                'sendTargetingKeys': false,
+                'title': 'Product title',
+                'description': 'Product desc',
+                'price': '100',
+                'click_url': 'https://product.click',
+                'image': {
+                  'url': 'https://publisherdirect.criteo.com/publishertag/preprodtest/creative.png',
+                  'height': 300,
+                  'width': 300
+                },
+                'call_to_action': 'Try it now!'
+              }],
+              'advertiser': {
+                'description': 'sponsor',
+                'domain': 'criteo.com',
+                'logo': { 'url': 'https://www.criteo.com/images/criteo-logo.svg', 'height': 300, 'width': 300 }
+              },
+              'privacy': {
+                'optout_click_url': 'https://info.criteo.com/privacy/informations',
+                'optout_image_url': 'https://static.criteo.net/flash/icon/nai_small.png',
+              },
+              'impression_pixels': [{ 'url': 'https://my-impression-pixel/test/impression' }, { 'url': 'https://cas.com/lg.com' }]
+            },
+            ext: {
+              meta: {
+                networkName: 'Criteo'
+              }
+            }
+          }],
+        },
+      };
+      const request = {
+        bidRequests: [{
+          adUnitCode: 'test-requestId',
+          bidId: 'test-bidId',
+          mediaTypes: {
+            native: {}
+          },
+          params: {
+            networkId: 456,
+          },
+        }, {
+          adUnitCode: 'test-requestId',
+          bidId: 'test-bidId2',
+          mediaTypes: {
+            banner: {
+              sizes: [[728, 90]]
+            }
+          },
+          params: {
+            networkId: 456,
+          }
+        }]
+      };
+      const bids = spec.interpretResponse(response, request);
+      expect(bids).to.have.lengthOf(1);
+      expect(bids[0].requestId).to.equal('test-bidId');
+      expect(bids[0].cpm).to.equal(1.23);
+      expect(bids[0].mediaType).to.equal(NATIVE);
+    });
+
     it('should properly parse a bid response with a zoneId', function () {
       const response = {
         body: {