prebid.js 5.18.0 → 6.1.0

package/test/spec/modules/engageyaBidAdapter_spec.js

@@ -0,0 +1,422 @@
+import { expect } from 'chai';
+import { spec } from 'modules/engageyaBidAdapter.js';
+import * as utils from 'src/utils.js';
+
+const ENDPOINT_URL = 'https://recs.engageya.com/rec-api/getrecs.json';
+
+describe('Engageya adapter', function () {
+  let bidRequests;
+  let nativeBidRequests;
+
+  beforeEach(function () {
+    bidRequests = [
+      {
+        bidder: 'engageya',
+        params: {
+          widgetId: 85610,
+          websiteId: 91140,
+          pageUrl: '[PAGE_URL]'
+        }
+      }
+    ]
+
+    nativeBidRequests = [
+      {
+        bidder: 'engageya',
+        params: {
+          widgetId: 85610,
+          websiteId: 91140,
+          pageUrl: '[PAGE_URL]'
+        },
+        nativeParams: {
+          title: {
+            required: true,
+            len: 80
+          },
+          image: {
+            required: true,
+            sizes: [150, 50]
+          },
+          sponsoredBy: {
+            required: true
+          }
+        }
+      }
+    ]
+  })
+
+  describe('isBidRequestValid', function () {
+    it('Valid bid case', function () {
+      let validBid = {
+        bidder: 'engageya',
+        params: {
+          widgetId: 85610,
+          websiteId: 91140,
+          pageUrl: '[PAGE_URL]'
+        },
+        sizes: [[300, 250]]
+      }
+      let isValid = spec.isBidRequestValid(validBid);
+      expect(isValid).to.be.true;
+    });
+
+    it('Invalid bid case: widgetId and websiteId is not passed', function () {
+      let validBid = {
+        bidder: 'engageya',
+        params: {}
+      }
+      let isValid = spec.isBidRequestValid(validBid);
+      expect(isValid).to.be.false;
+    })
+
+    it('Invalid bid case: widget id must be number', function () {
+      let invalidBid = {
+        bidder: 'engageya',
+        params: {
+          widgetId: '157746a',
+          websiteId: 91140,
+          pageUrl: '[PAGE_URL]'
+        },
+        sizes: [[300, 250]]
+      }
+      let isValid = spec.isBidRequestValid(invalidBid);
+      expect(isValid).to.be.false;
+    })
+
+    it('Invalid bid case: unsupported sizes', function () {
+      let invalidBid = {
+        bidder: 'engageya',
+        params: {
+          widgetId: '157746a',
+          websiteId: 91140,
+          pageUrl: '[PAGE_URL]'
+        },
+        sizes: [[250, 250]]
+      }
+      let isValid = spec.isBidRequestValid(invalidBid);
+      expect(isValid).to.be.false;
+    })
+  })
+
+  describe('buildRequests', function () {
+    it('sends bid request to ENDPOINT via GET', function () {
+      const request = spec.buildRequests(bidRequests)[0];
+      expect(request.url).to.include(ENDPOINT_URL);
+      expect(request.method).to.equal('GET');
+    });
+
+    it('buildRequests function should not modify original bidRequests object', function () {
+      let originalBidRequests = utils.deepClone(bidRequests);
+      let request = spec.buildRequests(bidRequests);
+      expect(bidRequests).to.deep.equal(originalBidRequests);
+    });
+
+    it('buildRequests function should not modify original nativeBidRequests object', function () {
+      let originalBidRequests = utils.deepClone(nativeBidRequests);
+      let request = spec.buildRequests(nativeBidRequests);
+      expect(nativeBidRequests).to.deep.equal(originalBidRequests);
+    });
+
+    it('Request params check', function () {
+      let request = spec.buildRequests(bidRequests)[0];
+      const urlParams = new URL(request.url).searchParams;
+      expect(parseInt(urlParams.get('wid'))).to.exist.and.to.equal(bidRequests[0].params.widgetId);
+      expect(parseInt(urlParams.get('webid'))).to.exist.and.to.equal(bidRequests[0].params.websiteId);
+    });
+
+    it('Request pageUrl - use param', function () {
+      const pageUrl = 'https://url.test';
+      bidRequests[0].params.pageUrl = pageUrl;
+      const request = spec.buildRequests(bidRequests)[0];
+      const urlParams = new URL(request.url).searchParams;
+      expect(urlParams.get('url')).to.exist.and.to.equal(pageUrl);
+    });
+  })
+
+  describe('interpretResponse', function () {
+    let nativeResponse;
+    let bannerResponse;
+
+    beforeEach(() => {
+      const recsResponse = {
+        recs: [
+          {
+            ecpm: 9.20,
+            pecpm: 0.0520,
+            postId: '<!-- CREATIVE ID -->',
+            thumbnail_path: 'https://engageya.live/wp-content/uploads/2019/05/images.png',
+            domain: 'domain.test',
+            title: 'Test title',
+            clickUrl: '//click.test',
+            url: '//url.test',
+            displayName: 'Test displayName',
+            trackers: {
+              impressionPixels: ['//impression.test'],
+              viewPixels: ['//view.test'],
+            }
+          }
+        ],
+        imageWidth: 300,
+        imageHeight: 250,
+        ireqId: '1d236f7890b',
+        viewPxl: '//view.pixel',
+      };
+
+      nativeResponse = {
+        ...recsResponse,
+        pbtypeId: 1,
+      }
+
+      bannerResponse = {
+        ...recsResponse,
+        pbtypeId: 2,
+        widget: {
+          additionalData: '{"css":".eng_tag_ttl{display:block!important}"}'
+        },
+      }
+    })
+
+    it('should return empty array if no response', function () {
+      const result = spec.interpretResponse({}, [])
+      expect(result).to.be.an('array').that.is.empty
+    });
+
+    it('should return empty array if no valid bids', function () {
+      let response = {
+        recs: [],
+        imageWidth: 300,
+        imageHeight: 250,
+        ireqId: '1d236f7890b',
+        pbtypeId: 2,
+        viewPxl: '//view.pixel',
+      };
+      let request = spec.buildRequests(bidRequests)[0];
+      const result = spec.interpretResponse({ body: response }, request)
+      expect(result).to.be.an('array').that.is.empty
+    });
+
+    it('should interpret native response', function () {
+      let expectedResult = [
+        {
+          requestId: '1d236f7890b',
+          cpm: 0.0520,
+          width: 300,
+          height: 250,
+          netRevenue: true,
+          currency: 'USD',
+          creativeId: '<!-- CREATIVE ID -->',
+          ttl: 360,
+          meta: {
+            advertiserDomains: ['domain.test']
+          },
+          native: {
+            title: 'Test title',
+            body: '',
+            image: {
+              url: 'https://engageya.live/wp-content/uploads/2019/05/images.png',
+              width: 300,
+              height: 250
+            },
+            privacyLink: '',
+            clickUrl: '//click.test',
+            displayUrl: '//url.test',
+            cta: '',
+            sponsoredBy: 'Test displayName',
+            impressionTrackers: ['//impression.test', '//view.test', '//view.pixel'],
+          },
+        }
+      ];
+      let request = spec.buildRequests(bidRequests)[0];
+      let result = spec.interpretResponse({ body: nativeResponse }, request);
+      expect(result).to.deep.equal(expectedResult);
+    });
+
+    it('should interpret native response - without pecpm', function () {
+      delete nativeResponse.recs[0].pecpm;
+      let expectedResult = [
+        {
+          requestId: '1d236f7890b',
+          cpm: 0.0920,
+          width: 300,
+          height: 250,
+          netRevenue: false,
+          currency: 'USD',
+          creativeId: '<!-- CREATIVE ID -->',
+          ttl: 360,
+          meta: {
+            advertiserDomains: ['domain.test']
+          },
+          native: {
+            title: 'Test title',
+            body: '',
+            image: {
+              url: 'https://engageya.live/wp-content/uploads/2019/05/images.png',
+              width: 300,
+              height: 250
+            },
+            privacyLink: '',
+            clickUrl: '//click.test',
+            displayUrl: '//url.test',
+            cta: '',
+            sponsoredBy: 'Test displayName',
+            impressionTrackers: ['//impression.test', '//view.test', '//view.pixel'],
+          },
+        }
+      ];
+      let request = spec.buildRequests(bidRequests)[0];
+      let result = spec.interpretResponse({ body: nativeResponse }, request);
+      expect(result).to.deep.equal(expectedResult);
+    });
+
+    it('should interpret native response - without trackers', function () {
+      delete nativeResponse.recs[0].trackers;
+      let expectedResult = [
+        {
+          requestId: '1d236f7890b',
+          cpm: 0.0520,
+          width: 300,
+          height: 250,
+          netRevenue: true,
+          currency: 'USD',
+          creativeId: '<!-- CREATIVE ID -->',
+          ttl: 360,
+          meta: {
+            advertiserDomains: ['domain.test']
+          },
+          native: {
+            title: 'Test title',
+            body: '',
+            image: {
+              url: 'https://engageya.live/wp-content/uploads/2019/05/images.png',
+              width: 300,
+              height: 250
+            },
+            privacyLink: '',
+            clickUrl: '//click.test',
+            displayUrl: '//url.test',
+            cta: '',
+            sponsoredBy: 'Test displayName',
+            impressionTrackers: ['//view.pixel'],
+          },
+        }
+      ];
+      let request = spec.buildRequests(bidRequests)[0];
+      let result = spec.interpretResponse({ body: nativeResponse }, request);
+      expect(result).to.deep.equal(expectedResult);
+    });
+
+    it('should interpret display response', function () {
+      let expectedResult = [
+        {
+          requestId: '1d236f7890b',
+          cpm: 0.0520,
+          width: 300,
+          height: 250,
+          netRevenue: true,
+          currency: 'USD',
+          creativeId: '<!-- CREATIVE ID -->',
+          ttl: 360,
+          meta: {
+            advertiserDomains: ['domain.test']
+          },
+          ad: `<html><body><style>.eng_tag_ttl{display:block!important}</style><div id="ENG_TAG"><a href="//click.test" target=_blank><img class="eng_tag_img" src="https://engageya.live/wp-content/uploads/2019/05/images.png" style="width:300px;height:250px;" alt="Test title"/><div class="eng_tag_brnd" style="display: none">Test displayName</div><div class="eng_tag_ttl" style="display: none">Test title</div></a><div style="position:absolute;left:0px;top:0px;visibility:hidden;"><img src="//impression.test"></div><div style="position:absolute;left:0px;top:0px;visibility:hidden;"><img src="//view.test"></div><div style="position:absolute;left:0px;top:0px;visibility:hidden;"><img src="//view.pixel"></div></div></body></html>`,
+        }
+      ];
+      let request = spec.buildRequests(bidRequests)[0];
+      let result = spec.interpretResponse({ body: bannerResponse }, request);
+      expect(result).to.deep.equal(expectedResult);
+    });
+
+    it('should interpret display response - without pecpm', function () {
+      delete bannerResponse.recs[0].pecpm;
+      let expectedResult = [
+        {
+          requestId: '1d236f7890b',
+          cpm: 0.0920,
+          width: 300,
+          height: 250,
+          netRevenue: false,
+          currency: 'USD',
+          creativeId: '<!-- CREATIVE ID -->',
+          ttl: 360,
+          meta: {
+            advertiserDomains: ['domain.test']
+          },
+          ad: `<html><body><style>.eng_tag_ttl{display:block!important}</style><div id="ENG_TAG"><a href="//click.test" target=_blank><img class="eng_tag_img" src="https://engageya.live/wp-content/uploads/2019/05/images.png" style="width:300px;height:250px;" alt="Test title"/><div class="eng_tag_brnd" style="display: none">Test displayName</div><div class="eng_tag_ttl" style="display: none">Test title</div></a><div style="position:absolute;left:0px;top:0px;visibility:hidden;"><img src="//impression.test"></div><div style="position:absolute;left:0px;top:0px;visibility:hidden;"><img src="//view.test"></div><div style="position:absolute;left:0px;top:0px;visibility:hidden;"><img src="//view.pixel"></div></div></body></html>`,
+        }
+      ];
+      let request = spec.buildRequests(bidRequests)[0];
+      let result = spec.interpretResponse({ body: bannerResponse }, request);
+      expect(result).to.deep.equal(expectedResult);
+    });
+
+    it('should interpret display response - without title', function () {
+      bannerResponse.recs[0].title = ' ';
+      let expectedResult = [
+        {
+          requestId: '1d236f7890b',
+          cpm: 0.0520,
+          width: 300,
+          height: 250,
+          netRevenue: true,
+          currency: 'USD',
+          creativeId: '<!-- CREATIVE ID -->',
+          ttl: 360,
+          meta: {
+            advertiserDomains: ['domain.test']
+          },
+          ad: `<html><body><style>.eng_tag_ttl{display:block!important}</style><div id="ENG_TAG"><a href="//click.test" target=_blank><img class="eng_tag_img" src="https://engageya.live/wp-content/uploads/2019/05/images.png" style="width:300px;height:250px;" alt=" "/></a><div style="position:absolute;left:0px;top:0px;visibility:hidden;"><img src="//impression.test"></div><div style="position:absolute;left:0px;top:0px;visibility:hidden;"><img src="//view.test"></div><div style="position:absolute;left:0px;top:0px;visibility:hidden;"><img src="//view.pixel"></div></div></body></html>`,
+        }
+      ];
+      let request = spec.buildRequests(bidRequests)[0];
+      let result = spec.interpretResponse({ body: bannerResponse }, request);
+      expect(result).to.deep.equal(expectedResult);
+    });
+
+    it('should interpret display response - without widget additional data', function () {
+      bannerResponse.widget.additionalData = null;
+      let expectedResult = [
+        {
+          requestId: '1d236f7890b',
+          cpm: 0.0520,
+          width: 300,
+          height: 250,
+          netRevenue: true,
+          currency: 'USD',
+          creativeId: '<!-- CREATIVE ID -->',
+          ttl: 360,
+          meta: {
+            advertiserDomains: ['domain.test']
+          },
+          ad: `<html><body><div id="ENG_TAG"><a href="//click.test" target=_blank><img class="eng_tag_img" src="https://engageya.live/wp-content/uploads/2019/05/images.png" style="width:300px;height:250px;" alt="Test title"/><div class="eng_tag_brnd" style="display: none">Test displayName</div><div class="eng_tag_ttl" style="display: none">Test title</div></a><div style="position:absolute;left:0px;top:0px;visibility:hidden;"><img src="//impression.test"></div><div style="position:absolute;left:0px;top:0px;visibility:hidden;"><img src="//view.test"></div><div style="position:absolute;left:0px;top:0px;visibility:hidden;"><img src="//view.pixel"></div></div></body></html>`,
+        }
+      ];
+      let request = spec.buildRequests(bidRequests)[0];
+      let result = spec.interpretResponse({ body: bannerResponse }, request);
+      expect(result).to.deep.equal(expectedResult);
+    });
+
+    it('should interpret display response - without trackers', function () {
+      bannerResponse.recs[0].trackers = null;
+      let expectedResult = [
+        {
+          requestId: '1d236f7890b',
+          cpm: 0.0520,
+          width: 300,
+          height: 250,
+          netRevenue: true,
+          currency: 'USD',
+          creativeId: '<!-- CREATIVE ID -->',
+          ttl: 360,
+          meta: {
+            advertiserDomains: ['domain.test']
+          },
+          ad: `<html><body><style>.eng_tag_ttl{display:block!important}</style><div id="ENG_TAG"><a href="//click.test" target=_blank><img class="eng_tag_img" src="https://engageya.live/wp-content/uploads/2019/05/images.png" style="width:300px;height:250px;" alt="Test title"/><div class="eng_tag_brnd" style="display: none">Test displayName</div><div class="eng_tag_ttl" style="display: none">Test title</div></a><div style="position:absolute;left:0px;top:0px;visibility:hidden;"><img src="//view.pixel"></div></div></body></html>`,
+        }
+      ];
+      let request = spec.buildRequests(bidRequests)[0];
+      let result = spec.interpretResponse({ body: bannerResponse }, request);
+      expect(result).to.deep.equal(expectedResult);
+    });
+  })
+})

package/test/spec/modules/eplanningBidAdapter_spec.js

@@ -328,26 +328,25 @@ describe('E-Planning Adapter', function () {
   describe('buildRequests', function () {
     let bidRequests = [validBid];
     let sandbox;
+    let getWindowSelfStub;
+    let innerWidth;
     beforeEach(() => {
       sandbox = sinon.sandbox.create();
+      getWindowSelfStub = sandbox.stub(utils, 'getWindowSelf');
+      getWindowSelfStub.returns(createWindow(800));
     });
 
     afterEach(() => {
       sandbox.restore();
     });
 
-    const createWindow = () => {
+    const createWindow = (innerWidth) => {
       const win = {};
       win.self = win;
-      win.innerWidth = 1025;
+      win.innerWidth = innerWidth;
       return win;
     };
 
-    function setupSingleWindow(sandBox) {
-      const win = createWindow();
-      sandBox.stub(utils, 'getWindowSelf').returns(win);
-    }
-
     it('should create the url correctly', function () {
       const url = spec.buildRequests(bidRequests, bidderRequest).url;
       expect(url).to.equal('https://pbjs.e-planning.net/pbjs/1/' + CI + '/1/localhost/ROS');
@@ -516,7 +515,8 @@ describe('E-Planning Adapter', function () {
 
     it('should return the e parameter with a value according to the sizes in order corresponding to the desktop priority list of the ad units', function () {
       let bidRequestsPrioritySizes = [validBidExistingSizesInPriorityListForDesktop];
-      setupSingleWindow(sandbox);
+      // overwrite default innerWdith for tests with a larger one we consider "Desktop" or NOT Mobile
+      getWindowSelfStub.returns(createWindow(1025));
       const e = spec.buildRequests(bidRequestsPrioritySizes, bidderRequest).data.e;
       expect(e).to.equal('300x250_0:300x250,300x600,970x250');
     });

package/test/spec/modules/glimpseBidAdapter_spec.js

@@ -1,3 +1,4 @@
+import { BANNER } from '../../../src/mediaTypes'
 import { expect } from 'chai'
 import { newBidder } from 'src/adapters/bidderFactory.js'
 import { spec } from 'modules/glimpseBidAdapter.js'
@@ -79,6 +80,20 @@ function getDeepCopy(object) {
 describe('GlimpseProtocolAdapter', () => {
   const glimpseAdapter = newBidder(spec)
 
+  describe('spec', () => {
+    it('Has defined the glimpse gvlid', () => {
+      expect(spec.gvlid).to.equal(1012)
+    })
+
+    it('Has defined glimpse as the bidder', () => {
+      expect(spec.code).to.equal('glimpse')
+    })
+
+    it('Has defined valid mediaTypes', () => {
+      expect(spec.supportedMediaTypes).to.deep.equal([BANNER])
+    })
+  })
+
   describe('Inherited functions', () => {
     it('Functions exist and are valid types', () => {
       expect(glimpseAdapter.callBids).to.exist.and.to.be.a('function')
@@ -163,6 +178,24 @@ describe('GlimpseProtocolAdapter', () => {
     const bidRequests = [getBidRequest()]
     const bidderRequest = getBidderRequest()
 
+    it('Adds a demo flag', () => {
+      const request = spec.buildRequests(bidRequests, bidderRequest)
+      const payload = JSON.parse(request.data)
+      expect(payload.data.demo).to.be.false
+    })
+
+    it('Adds an account id', () => {
+      const request = spec.buildRequests(bidRequests, bidderRequest)
+      const payload = JSON.parse(request.data)
+      expect(payload.data.account).to.equal(-1)
+    })
+
+    it('Adds a demand provider', () => {
+      const request = spec.buildRequests(bidRequests, bidderRequest)
+      const payload = JSON.parse(request.data)
+      expect(payload.data.demand).to.equal('glimpse')
+    })
+
     it('Adds GDPR consent', () => {
       const request = spec.buildRequests(bidRequests, bidderRequest)
       const payload = JSON.parse(request.data)

package/test/spec/modules/gptPreAuction_spec.js

@@ -197,15 +197,69 @@ describe('GPT pre-auction module', () => {
         code: 'slotCode3',
       }];
 
+      // first two adUnits directly pass in pbadslot => gpid is same
       const expectedAdUnits = [{
         code: 'adUnit1',
-        ortb2Imp: { ext: { data: { pbadslot: '12345' } } }
-      }, {
+        ortb2Imp: {
+          ext: {
+            data: {
+              pbadslot: '12345'
+            },
+            gpid: '12345'
+          }
+        }
+      },
+      // second adunit
+      {
         code: 'slotCode1',
-        ortb2Imp: { ext: { data: { pbadslot: '67890', adserver: { name: 'gam', adslot: 'slotCode1' } } } }
+        ortb2Imp: {
+          ext: {
+            data: {
+              pbadslot: '67890',
+              adserver: {
+                name: 'gam',
+                adslot: 'slotCode1'
+              }
+            },
+            gpid: '67890'
+          }
+        }
       }, {
         code: 'slotCode3',
-        ortb2Imp: { ext: { data: { pbadslot: 'slotCode3', adserver: { name: 'gam', adslot: 'slotCode3' } } } }
+        ortb2Imp: {
+          ext: {
+            data: {
+              pbadslot: 'slotCode3',
+              adserver: {
+                name: 'gam',
+                adslot: 'slotCode3'
+              }
+            },
+            gpid: 'slotCode3'
+          }
+        }
+      }];
+
+      window.googletag.pubads().setSlots(testSlots);
+      runMakeBidRequests(testAdUnits);
+      expect(returnedAdUnits).to.deep.equal(expectedAdUnits);
+    });
+
+    it('should not apply gpid if pbadslot was set by adUnitCode', () => {
+      const testAdUnits = [{
+        code: 'noMatchCode',
+      }];
+
+      // first two adUnits directly pass in pbadslot => gpid is same
+      const expectedAdUnits = [{
+        code: 'noMatchCode',
+        ortb2Imp: {
+          ext: {
+            data: {
+              pbadslot: 'noMatchCode'
+            },
+          }
+        }
       }];
 
       window.googletag.pubads().setSlots(testSlots);

package/test/spec/modules/gumgumBidAdapter_spec.js

@@ -531,9 +531,13 @@ describe('gumgumAdapter', function () {
       const jcsi = JSON.stringify(JCSI);
       const bidRequest = spec.buildRequests(bidRequests)[0];
       const actualKeys = Object.keys(JSON.parse(bidRequest.data.jcsi)).sort();
-      expect(actualKeys).to.eq(actualKeys);
+      expect(actualKeys).to.eql(expectedKeys);
       expect(bidRequest.data.jcsi).to.eq(jcsi);
     });
+    it('should include the local time and timezone offset', function () {
+      const bidRequest = spec.buildRequests(bidRequests)[0];
+      expect(!!bidRequest.data.lt).to.be.true;
+    });
   })
 
   describe('interpretResponse', function () {

package/test/spec/modules/imRtdProvider_spec.js

@@ -1,6 +1,7 @@
 import {
   imRtdSubmodule,
   storage,
+  getBidderFunction,
   getCustomBidderFunction,
   setRealTimeData,
   getRealTimeData,
@@ -47,6 +48,30 @@ describe('imRtdProvider', function () {
     })
   })
 
+  describe('getBidderFunction', function () {
+    const assumedBidder = [
+      'ix',
+      'pubmatic'
+    ];
+    assumedBidder.forEach(bidderName => {
+      it(`should return bidderFunction with assumed bidder: ${bidderName}`, function () {
+        expect(getBidderFunction(bidderName)).to.exist.and.to.be.a('function');
+      });
+
+      it(`should return bid with correct key data: ${bidderName}`, function () {
+        const bid = {bidder: bidderName};
+        expect(getBidderFunction(bidderName)(bid, {'im_segments': ['12345', '67890']})).to.equal(bid);
+      });
+      it(`should return bid without data: ${bidderName}`, function () {
+        const bid = {bidder: bidderName};
+        expect(getBidderFunction(bidderName)(bid, '')).to.equal(bid);
+      });
+    });
+    it(`should return null with unexpected bidder`, function () {
+      expect(getBidderFunction('test')).to.equal(null);
+    });
+  })
+
   describe('getCustomBidderFunction', function () {
     it('should return config function', function () {
       const config = {