prebid.js 7.12.0 → 7.13.0

package/test/spec/modules/ixBidAdapter_spec.js

@@ -171,7 +171,8 @@ describe('IndexexchangeAdapter', function () {
       sizes: [[300, 250], [300, 600]],
       mediaTypes: {
         banner: {
-          sizes: [[300, 250], [300, 600]]
+          sizes: [[300, 250], [300, 600]],
+          pos: 0
         }
       },
       ortb2Imp: {
@@ -1839,6 +1840,7 @@ describe('IndexexchangeAdapter', function () {
       expect(impression.id).to.equal(DEFAULT_BANNER_VALID_BID[0].bidId);
       expect(impression.banner.format).to.be.length(2);
       expect(impression.banner.topframe).to.be.oneOf([0, 1]);
+      expect(impression.banner.pos).to.equal(0);
       expect(impression.ext.tid).to.equal(DEFAULT_BANNER_VALID_BID[0].transactionId);
 
       impression.banner.format.map(({ w, h, ext }, index) => {
@@ -2323,15 +2325,7 @@ describe('IndexexchangeAdapter', function () {
     });
 
     describe('detect missing sizes', function () {
-      beforeEach(function () {
-        config.setConfig({
-          ix: {
-            detectMissingSizes: false
-          }
-        });
-      })
-
-      it('request should not contain missing sizes if detectMissingSizes = false', function () {
+      it('request should always contain missing sizes', function () {
         const bid1 = utils.deepClone(DEFAULT_BANNER_VALID_BID[0]);
         bid1.mediaTypes.banner.sizes = LARGE_SET_OF_SIZES;
 
@@ -2448,11 +2442,13 @@ describe('IndexexchangeAdapter', function () {
       bid.mediaTypes.video.protocols = [6];
       bid.mediaTypes.video.mimes = ['video/mp4'];
       bid.mediaTypes.video.api = 2;
+      bid.mediaTypes.video.pos = 0;
       const request = spec.buildRequests([bid], {})[0];
       const impression = JSON.parse(request.data.r).imp[0];
 
       expect(impression.video.protocols[0]).to.equal(6);
       expect(impression.video.api).to.equal(2);
+      expect(impression.video.pos).to.equal(0);
       expect(impression.video.mimes[0]).to.equal('video/mp4');
     });
 
@@ -2689,15 +2685,6 @@ describe('IndexexchangeAdapter', function () {
         expect(videoImp.video.w).to.equal(DEFAULT_MULTIFORMAT_VIDEO_VALID_BID[0].params.size[0]);
         expect(videoImp.video.h).to.equal(DEFAULT_MULTIFORMAT_VIDEO_VALID_BID[0].params.size[1]);
       });
-
-      it('should get missing sizes count 0 when params.size not used', function () {
-        const bid = utils.deepClone(DEFAULT_MULTIFORMAT_VIDEO_VALID_BID[0]);
-        delete bid.params.size;
-        const request = spec.buildRequests([bid], {});
-        const diagObj = JSON.parse(request[0].data.r).ext.ixdiag;
-        expect(diagObj.msd).to.equal(0);
-        expect(diagObj.msi).to.equal(0);
-      });
     });
 
     describe('both banner and video bidder params set', function () {

package/test/spec/modules/lifestreetBidAdapter_spec.js

@@ -0,0 +1,232 @@
+import { expect } from 'chai';
+import { BANNER, VIDEO } from 'src/mediaTypes.js';
+import { spec } from 'modules/lifestreetBidAdapter.js';
+
+describe('lifestreetBidAdapter', function() {
+  let bidRequests;
+  let videoBidRequests;
+  let bidResponses;
+  let videoBidResponses;
+  beforeEach(function() {
+    bidRequests = [
+      {
+        bidder: 'lifestreet',
+        params: {
+          slot: 'slot166704',
+          adkey: '78c',
+          ad_size: '160x600'
+        },
+        mediaTypes: {
+          banner: {
+            sizes: [
+              [160, 600],
+              [300, 600]
+            ]
+          }
+        },
+        sizes: [
+          [160, 600],
+          [300, 600]
+        ]
+      }
+    ];
+
+    bidResponses = {
+      body: {
+        cpm: 0.1,
+        netRevenue: true,
+        content_type: 'display_flash',
+        width: 160,
+        currency: 'USD',
+        ttl: 86400,
+        content: '<iframe src=\'https://ads.lfstmedia.com/displayAd?__ads=ip37346-u0T8r2uJ8245jv6i2QE8Qu&adt=5748927953915945176&seq=2&plc=K73sUSWIH9WwpIQiGybtg8lYdYFld5NvswMmfGBMz6U&__df=true&clickUrl=https%3A%2F%2Fads.lfstmedia.com%2Fclick%2Fcmp15299%2F5748927953915945176%2F2%3F__ads%3Dip37346-u0T8r2uJ8245jv6i2QE8Qu%26adkey%3D6bd%26slot%3Dslot166704%26__stamp%3D1583331395140%26ad%3Dcrv197050%26_cx%3D%24%24CX%24%24%26_cy%3D%24%24CY%24%24%26_celt%3D%24%24ELT-ID%24%24%26redirectURL%3D\' width=\'160\' height=\'600\' frameBorder=\'0\' scrolling=\'no\' framespacing=\'0\' marginheight=\'0\' marginwidth=\'0\'><!--test--><\/iframe>\n',
+        creativeId: 7985076,
+        height: 600,
+        status: 1
+      }
+    };
+    videoBidRequests = [
+      {
+        bidder: 'lifestreet',
+        params: {
+          slot: 'slot1227631',
+          adkey: 'a98',
+          ad_size: '640x480'
+        },
+        mediaTypes: {
+          video: {
+            sizes: [
+              [640, 480],
+            ]
+          }
+        }
+      }
+    ]
+
+    videoBidResponses = {
+      body: {
+        cpm: 0.1,
+        netRevenue: true,
+        content_type: 'vast_3_0',
+        width: 640,
+        currency: 'USD',
+        ttl: 86400,
+        content: '<iframe src="https://ads.lfstmedia.com/displayAd?__ads=ip38770-u0T8r2uJ8245jv6i2QE8Qu&adt=7734389071973843496&seq=2&plc=QEw02HSSpFZCrGaMUP5rN01QQtwPM5iEI5EQzt1nV4E&__df=true&clickUrl=https%3A%2F%2Fads.lfstmedia.com%2Fclick%2Fcmp20228%2F7734389071973843496%2F2%3F__ads%3Dip38770-u0T8r2uJ8245jv6i2QE8Qu%26adkey%3Dcdc%26slot%3Dslot1227631%26__stamp%3D1583766419183%26ad%3Dcrv225652%26_cx%3D%24%24CX%24%24%26_cy%3D%24%24CY%24%24%26_celt%3D%24%24ELT-ID%24%24%26redirectURL%3D" width="640" height="480" frameBorder="0" scrolling="no" framespacing="0" marginheight="0" marginwidth="0"><!--test--><\/iframe>\n',
+        creativeId: 108323592,
+        height: 480,
+        status: 1
+      }
+    };
+  });
+  describe('implementation', function() {
+    describe('Bid validations', function() {
+      it('valid bid case', function() {
+        const validBid = {
+          bidder: 'lifestreet',
+          params: {
+            slot: 'slot166704',
+            adkey: '78c',
+            ad_size: '160x600'
+          }
+        };
+        expect(spec.isBidRequestValid(validBid)).to.equal(true);
+      });
+
+      it('invalid bid case', function() {
+        expect(spec.isBidRequestValid()).to.equal(false);
+      });
+
+      it('invalid bid case: slot not passed', function() {
+        var validBid = {
+          bidder: 'lifestreet',
+          params: {
+            adkey: '78c',
+            ad_size: '160x600'
+          }
+        };
+        expect(spec.isBidRequestValid(validBid)).to.equal(false);
+      });
+
+      it('invalid bid case: adkey not passed', function() {
+        const validBid = {
+          bidder: 'lifestreet',
+          params: {
+            slot: 'slot166704',
+            ad_size: '160x600'
+          }
+        };
+        expect(spec.isBidRequestValid(validBid)).to.equal(false);
+      });
+
+      it('invalid bid case: ad_size is not passed', function() {
+        const validBid = {
+          bidder: 'lifestreet',
+          params: {
+            slot: 'slot166704',
+            adkey: '78c'
+          }
+        };
+        expect(spec.isBidRequestValid(validBid)).to.equal(false);
+      });
+    });
+
+    describe('buildRequests spec method', function () {
+      it('method exists and is a function', function () {
+        expect(spec.buildRequests).to.exist.and.to.be.a('function');
+      });
+
+      it('should not return request when no bids are present', function () {
+        const [request] = spec.buildRequests([]);
+        expect(request).to.be.undefined;
+      });
+
+      it('should return an url and request method ', function () {
+        const [request] = spec.buildRequests(bidRequests);
+        expect(request.method).to.equal('GET');
+        expect(request.url).to.be.a('string');
+      });
+
+      it('should return an url that contains all required fields', function () {
+        const [request] = spec.buildRequests(bidRequests);
+        expect(request.url).to.have.string('adkey');
+        expect(request.url).to.have.string('slot');
+        expect(request.url).to.have.string('ad_size');
+      });
+
+      it('should add GDPR consent information to the request', function () {
+        let consentString = 'BOJ8RZsOJ8RZsABAB8AAAAAZ+A==';
+        let bidderRequest = {
+          bidderCode: 'lifestreet',
+          auctionId: '1d1a030790a875',
+          bidderRequestId: '22edbae2744bf6',
+          timeout: 3000,
+          gdprConsent: {
+            consentString: consentString,
+            gdprApplies: true
+          }
+        };
+        bidderRequest.bids = bidRequests;
+
+        const [request] = spec.buildRequests(bidRequests, bidderRequest);
+        expect(request.url).to.have.string('__gdpr=1');
+        expect(request.url).to.have.string(`__consent=${consentString}`);
+      });
+
+      it('should add US privacy string to request', function() {
+        let consentString = '1YA-';
+        let bidderRequest = {
+          bidderCode: 'lifestreet',
+          auctionId: '1d1a030790a875',
+          bidderRequestId: '22edbae2744bf6',
+          timeout: 3000,
+          uspConsent: consentString
+        };
+        bidderRequest.bids = bidRequests;
+
+        const [request] = spec.buildRequests(bidRequests, bidderRequest);
+        expect(request.url).to.have.string(`__us_privacy=${consentString}`);
+      });
+    });
+
+    describe('server response', function() {
+      it('should return valid proper values', function() {
+        const request = spec.buildRequests(bidRequests);
+        const response = spec.interpretResponse(bidResponses, request);
+        expect(response).to.be.an('array').with.length.above(0);
+        expect(response[0].cpm).to.equal(bidResponses.body.cpm);
+        expect(response[0].width).to.equal(bidResponses.body.width);
+        expect(response[0].height).to.equal(bidResponses.body.height);
+        expect(response[0].creativeId).to.equal(bidResponses.body.creativeId);
+        expect(response[0].currency).to.equal('USD');
+        expect(response[0].netRevenue).to.equal(true);
+        expect(response[0].ttl).to.equal(bidResponses.body.ttl);
+      });
+
+      it('should return proper mediaType for BANNER', function() {
+        const request = spec.buildRequests(bidRequests);
+        const [response] = spec.interpretResponse(bidResponses, request);
+        expect(response.mediaType).to.equal(BANNER);
+      });
+
+      it('should return proper mediaType for VIDEO', function() {
+        const request = spec.buildRequests(videoBidRequests);
+        const [response] = spec.interpretResponse(videoBidResponses, request);
+        expect(response.mediaType).to.equal(VIDEO);
+      });
+
+      it('should return a VAST XML for VIDEO', function() {
+        const request = spec.buildRequests(videoBidRequests);
+        const [response] = spec.interpretResponse(videoBidResponses, request);
+        expect(response.vastXml).to.be.a('string');
+        expect(response.vastXml).to.have.string('iframe');
+      });
+
+      it('should return an ad content for BANNER', function() {
+        const request = spec.buildRequests(bidRequests);
+        const [response] = spec.interpretResponse(bidResponses, request);
+        expect(response.ad).to.be.a('string');
+        expect(response.ad).to.have.string('iframe');
+      });
+    });
+  });
+});

package/test/spec/modules/limelightDigitalBidAdapter_spec.js

@@ -1,5 +1,5 @@
-import {expect} from 'chai';
-import {spec} from '../../../modules/limelightDigitalBidAdapter.js';
+import { expect } from 'chai';
+import { spec } from '../../../modules/limelightDigitalBidAdapter.js';
 
 describe('limelightDigitalAdapter', function () {
   const bid1 = {
@@ -29,7 +29,18 @@ describe('limelightDigitalAdapter', function () {
           }
         ]
       }
-    ]
+    ],
+    schain: {
+      ver: '1.0',
+      complete: 1,
+      nodes: [
+        {
+          asi: 'example.com',
+          sid: '1',
+          hp: 1
+        }
+      ]
+    }
   }
   const bid2 = {
     bidId: '58ee9870c3164a',
@@ -53,7 +64,23 @@ describe('limelightDigitalAdapter', function () {
           }
         ]
       }
-    ]
+    ],
+    schain: {
+      ver: '1.0',
+      complete: 1,
+      nodes: [
+        {
+          asi: 'example.com',
+          sid: '1',
+          hp: 1
+        },
+        {
+          asi: 'example1.com',
+          sid: '2',
+          hp: 1
+        }
+      ]
+    }
   }
   const bid3 = {
     bidId: '019645c7d69460',
@@ -81,7 +108,18 @@ describe('limelightDigitalAdapter', function () {
           }
         ]
       }
-    ]
+    ],
+    schain: {
+      ver: '1.0',
+      complete: 1,
+      nodes: [
+        {
+          asi: 'example.com',
+          sid: '1',
+          hp: 1
+        }
+      ]
+    }
   }
   const bid4 = {
     bidId: '019645c7d69460',
@@ -107,7 +145,18 @@ describe('limelightDigitalAdapter', function () {
           }
         ]
       }
-    ]
+    ],
+    schain: {
+      ver: '1.0',
+      complete: 1,
+      nodes: [
+        {
+          asi: 'example.com',
+          sid: '1',
+          hp: 1
+        }
+      ]
+    }
   }
 
   describe('buildRequests', function () {
@@ -146,7 +195,8 @@ describe('limelightDigitalAdapter', function () {
             'sizes',
             'transactionId',
             'publisherId',
-            'userIdAsEids'
+            'userIdAsEids',
+            'supplyChain'
           );
           expect(adUnit.id).to.be.a('number');
           expect(adUnit.bidId).to.be.a('string');
@@ -154,6 +204,7 @@ describe('limelightDigitalAdapter', function () {
           expect(adUnit.transactionId).to.be.a('string');
           expect(adUnit.sizes).to.be.an('array');
           expect(adUnit.userIdAsEids).to.be.an('array');
+          expect(adUnit.supplyChain).to.be.an('object');
         })
       })
     })
@@ -587,4 +638,5 @@ function validateAdUnit(adUnit, bid) {
   }));
   expect(adUnit.publisherId).to.equal(bid.params.publisherId);
   expect(adUnit.userIdAsEids).to.deep.equal(bid.userIdAsEids);
+  expect(adUnit.supplyChain).to.deep.equal(bid.schain);
 }

package/test/spec/modules/mabidderBidAdapter_spec.js

@@ -0,0 +1,125 @@
+import { expect } from 'chai'
+import { baseUrl, spec } from 'modules/mabidderBidAdapter.js'
+import { newBidder } from 'src/adapters/bidderFactory.js'
+import { BANNER } from '../../../src/mediaTypes.js';
+
+describe('mabidderBidAdapter', () => {
+  const adapter = newBidder(spec)
+  const bidRequestBanner = {
+    'bidId': '12345',
+    'bidder': 'mabidder',
+    'sizes': [[300, 250]],
+    'mediaTypes': {
+      'banner': {
+        'sizes': [[300, 250]]
+      }
+    },
+    'params': {
+      'ppid': 'string1',
+    }
+
+  }
+
+  describe('inherited functions', () => {
+    it('exists and is a function', () => {
+      expect(adapter.callBids).to.exist.and.to.be.a('function')
+    })
+  })
+
+  describe('isBidRequestValid', () => {
+    it('should return true when required params are found', () => {
+      expect(spec.isBidRequestValid(bidRequestBanner)).to.equal(true)
+    })
+
+    it('should return false when required params are not found', () => {
+      let bid = Object.assign({}, bidRequestBanner)
+      const ppid = bid.params.ppid
+      delete bid.params.ppid
+      expect(spec.isBidRequestValid(bid)).to.equal(false)
+      bid.params.ppid = ppid
+
+      bid = Object.assign({}, bidRequestBanner)
+      const params = bidRequestBanner.params
+      delete bid.params
+      expect(spec.isBidRequestValid(bid)).to.equal(false)
+      bidRequestBanner.params = params
+    })
+  })
+
+  describe('buildRequests', () => {
+    const bidRequests = [bidRequestBanner]
+    const req = spec.buildRequests(bidRequests, {
+      auctionId: '123',
+      refererInfo: {
+        referer: 'http://test.com/path.html'
+      }
+    })
+
+    it('sends bid request to ENDPOINT via POST', () => {
+      expect(req.method).to.equal('POST')
+      expect(req.url.indexOf('https://')).to.equal(0)
+      expect(req.url).to.equal(baseUrl)
+    })
+
+    it('contains prebid version parameter', () => {
+      expect(req.data.v).to.equal($$PREBID_GLOBAL$$.version)
+    })
+
+    it('sends the correct bid parameters for banner', () => {
+      expect(req.data.bids[0].bidId).to.equal(bidRequestBanner.bidId)
+      expect(req.data.bids[0].ppid).to.equal(bidRequestBanner.params.ppid)
+      expect(req.data.bids[0].sizes[0].width).to.equal(bidRequestBanner.sizes[0][0])
+      expect(req.data.bids[0].sizes[0].height).to.equal(bidRequestBanner.sizes[0][1])
+    })
+
+    it('accepts an optional fpd parameter', () => {
+      expect(req.data.fpd).to.exist.and.to.be.a('Object')
+    })
+  })
+
+  describe('interpretResponse', () => {
+    it('handles banner request and should get correct bid response', () => {
+      const BIDDER_RESPONSE_BANNER = {
+        'Responses': [{
+          'width': 300,
+          'height': 250,
+          'creativeId': '123abc',
+          'ad': '<!-- Creative -->',
+          'cpm': 0.5,
+          'requestId': 'abc123',
+          'ttl': 60,
+          'netRevenue': true,
+          'currency': 'USD',
+          'mediaType': BANNER,
+          'meta': {
+            'advertiserDomains': ['https://loblaws.ca']
+          }
+        }]
+      }
+      const results = spec.interpretResponse({ body: BIDDER_RESPONSE_BANNER }, {})
+      const response = results[0]
+      expect(results.length).to.equal(BIDDER_RESPONSE_BANNER.Responses.length)
+      expect(response).to.have.property('ad').equal('<!-- Creative -->')
+      expect(response).to.have.property('requestId').equal('abc123')
+      expect(response).to.have.property('cpm').equal(0.5)
+      expect(response).to.have.property('currency').equal('USD')
+      expect(response).to.have.property('width').equal(300)
+      expect(response).to.have.property('height').equal(250)
+      expect(response).to.have.property('ttl').equal(60)
+      expect(response).to.have.property('creativeId').equal('123abc')
+      expect(response).to.have.property('mediaType').equal(BANNER)
+      expect(response).to.have.property('meta')
+      expect(response.meta).to.have.property('advertiserDomains')
+      expect(response.meta.advertiserDomains).to.be.an('array')
+      expect(response.meta.advertiserDomains[0]).equal('https://loblaws.ca')
+    })
+
+    it('handles no bid response by returning empty array', () => {
+      let result = spec.interpretResponse({ body: undefined }, {})
+      expect(result).to.deep.equal([])
+
+      result = spec.interpretResponse({ body: '' }, {})
+      expect(result).to.deep.equal([])
+    })
+  })
+})

package/test/spec/modules/oneKeyIdSystem_spec.js

@@ -0,0 +1,107 @@
+import { oneKeyIdSubmodule } from 'modules/oneKeyIdSystem'
+
+const defaultConf = {
+  params: {
+    proxyHostName: 'proxy.com'
+  }
+};
+
+const defaultIdsAndPreferences = {
+  identifiers: [
+    {
+      version: '0.1',
+      type: 'paf_browser_id',
+      value: 'df0a5664-987d-4074-bbd9-e9b12ebae6ef',
+      source: {
+        domain: 'crto-poc-1.onekey.network',
+        timestamp: 1657100291,
+        signature: 'ikjV6WwpcroNB5XyLOr3MgYHLpS6UjICEOuv/jEr00uVrjZm0zluDSWh11OeGDZrMhxMBPeTabtQ4U2rNk3IzQ=='
+      }
+    }
+  ],
+  preferences: {
+    version: '0.1',
+    data: {
+      use_browsing_for_personalization: true
+    },
+    source: {
+      domain: 'cmp.pafdemopublisher.com',
+      timestamp: 1657100294,
+      signature: 'aAbMThxyeKpe/EgT5ARI1xecjCwwh0uRagsTuPXNY2fzh7foeW31qljDZf6h8UwOd9M2bAN7XNtM2LYBbJzskQ=='
+    }
+  }
+};
+
+const defaultIdsAndPreferencesResult = {
+  status: 'PARTICIPATING',
+  data: defaultIdsAndPreferences
+};
+
+describe('oneKeyData module', () => {
+  describe('getId function', () => {
+    beforeEach(() => {
+      setUpOneKey();
+    });
+
+    it('return a callback for handling asynchron results', () => {
+      const moduleIdResponse = oneKeyIdSubmodule.getId(defaultConf);
+
+      expect(moduleIdResponse.callback).to.be.an('function');
+    });
+
+    it(`return a callback that waits for OneKey to be loaded`, () => {
+      const moduleIdResponse = oneKeyIdSubmodule.getId(defaultConf);
+
+      moduleIdResponse.callback(function() {})
+
+      expect(window.OneKey.queue.length).to.equal(1);
+    });
+
+    it('return a callback that gets ids and prefs', () => {
+      const moduleIdResponse = oneKeyIdSubmodule.getId(defaultConf);
+
+      // Act
+      return new Promise((resolve) => {
+        moduleIdResponse.callback(resolve);
+        executeOneKeyQueue();
+      })
+
+      // Assert
+        .then((idsAndPrefs) => {
+          expect(idsAndPrefs).to.equal(defaultIdsAndPreferences);
+        });
+    });
+
+    it('return a callback with undefined if impossible to get ids and prefs', () => {
+      window.OneKey.getIdsAndPreferences = () => {
+        return Promise.reject(new Error(`Impossible to get ids and prefs`));
+      };
+      const moduleIdResponse = oneKeyIdSubmodule.getId(defaultConf);
+
+      // Act
+      return new Promise((resolve) => {
+        moduleIdResponse.callback(resolve);
+        executeOneKeyQueue();
+      })
+
+      // Assert
+        .then((idsAndPrefs) => {
+          expect(idsAndPrefs).to.be.undefined;
+        });
+    });
+  });
+});
+
+const setUpOneKey = () => {
+  window.OneKey.queue = [];
+  window.OneKey.getIdsAndPreferences = () => {
+    return Promise.resolve(defaultIdsAndPreferencesResult);
+  };
+}
+
+const executeOneKeyQueue = () => {
+  while (window.OneKey.queue.length > 0) {
+    window.OneKey.queue[0]();
+    window.OneKey.queue.shift();
+  }
+}