prebid.js 5.18.0 → 5.20.2

package/test/spec/modules/engageyaBidAdapter_spec.js

@@ -0,0 +1,286 @@
+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';
+
+export const _getUrlVars = function (url) {
+  var hash;
+  var myJson = {};
+  var hashes = url.slice(url.indexOf('?') + 1).split('&');
+  for (var i = 0; i < hashes.length; i++) {
+    hash = hashes[i].split('=');
+    myJson[hash[0]] = hash[1];
+  }
+  return myJson;
+}
+
+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]'
+        }
+      }
+      let isValid = spec.isBidRequestValid(validBid);
+      expect(isValid).to.equal(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.equal(false);
+    })
+
+    it('invalid bid case: widget id must be number', function () {
+      let invalidBid = {
+        bidder: 'engageya',
+        params: {
+          widgetId: '157746a',
+          websiteId: 91140,
+          pageUrl: '[PAGE_URL]'
+        }
+      }
+      let isValid = spec.isBidRequestValid(invalidBid);
+      expect(isValid).to.equal(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 data = _getUrlVars(request.url)
+      expect(parseInt(data.wid)).to.exist.and.to.equal(bidRequests[0].params.widgetId);
+      expect(parseInt(data.webid)).to.exist.and.to.equal(bidRequests[0].params.websiteId);
+    })
+  })
+
+  describe('interpretResponse', function () {
+    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
+      };
+      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 serverResponse = {
+        recs: [
+          {
+            ecpm: 0.0920,
+            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',
+        pbtypeId: 1
+      };
+      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'],
+          },
+        }
+      ];
+      let request = spec.buildRequests(bidRequests)[0];
+      let result = spec.interpretResponse({ body: serverResponse }, request);
+      expect(result).to.deep.equal(expectedResult);
+    });
+
+    it('should interpret display response', function () {
+      let serverResponse = {
+        recs: [
+          {
+            ecpm: 0.0920,
+            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',
+        pbtypeId: 2,
+        widget: {
+          additionalData: '{"css":".eng_tag_ttl{display:block!important}"}'
+        }
+      };
+      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></body></html>`,
+        }
+      ];
+      let request = spec.buildRequests(bidRequests)[0];
+      let result = spec.interpretResponse({ body: serverResponse }, request);
+      expect(result).to.deep.equal(expectedResult);
+    });
+
+    it('should interpret display response without title', function () {
+      let serverResponse = {
+        recs: [
+          {
+            ecpm: 0.0920,
+            postId: '<!-- CREATIVE ID -->',
+            thumbnail_path: 'https://engageya.live/wp-content/uploads/2019/05/images.png',
+            domain: 'domain.test',
+            title: ' ',
+            clickUrl: '//click.test',
+            url: '//url.test',
+            displayName: 'Test displayName',
+          }
+        ],
+        imageWidth: 300,
+        imageHeight: 250,
+        ireqId: '1d236f7890b',
+        pbtypeId: 2,
+      };
+      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><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></body></html>`,
+        }
+      ];
+      let request = spec.buildRequests(bidRequests)[0];
+      let result = spec.interpretResponse({ body: serverResponse }, 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/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/ipromBidAdapter_spec.js

@@ -0,0 +1,195 @@
+import {expect} from 'chai';
+import {spec} from 'modules/ipromBidAdapter.js';
+
+describe('iPROM Adapter', function () {
+  let bidRequests;
+  let bidderRequest;
+
+  beforeEach(function () {
+    bidRequests = [
+      {
+        bidder: 'iprom',
+        params: {
+          id: '1234',
+          dimension: '300x250',
+        },
+        adUnitCode: '/19966331/header-bid-tag-1',
+        mediaTypes: {
+          banner: {
+            sizes: [[300, 250], [300, 600]],
+          }
+        },
+        bidId: '29a72b151f7bd3',
+        auctionId: 'e36abb27-g3b1-1ad6-8a4c-701c8919d3hh',
+        bidderRequestId: '2z76da40m1b3cb8',
+        transactionId: 'j51lhf58-1ad6-g3b1-3j6s-912c9493g0gu'
+      }
+    ];
+
+    bidderRequest = {
+      timeout: 3000,
+      refererInfo: {
+        referer: 'https://adserver.si/index.html',
+        reachedTop: true,
+        numIframes: 1,
+        stack: [
+          'https://adserver.si/index.html',
+          'https://adserver.si/iframe1.html',
+        ]
+      }
+    }
+  });
+
+  describe('validating bids', function () {
+    it('should accept valid bid', function () {
+      let validBid = {
+        bidder: 'iprom',
+        params: {
+          id: '1234',
+          dimension: '300x250',
+        },
+      };
+
+      const isValid = spec.isBidRequestValid(validBid);
+
+      expect(isValid).to.equal(true);
+    });
+
+    it('should reject bid if missing dimension and id', function () {
+      let invalidBid = {
+        bidder: 'iprom',
+        params: {}
+      };
+
+      const isValid = spec.isBidRequestValid(invalidBid);
+
+      expect(isValid).to.equal(false);
+    });
+
+    it('should reject bid if missing dimension', function () {
+      let invalidBid = {
+        bidder: 'iprom',
+        params: {
+          id: '1234',
+        }
+      };
+
+      const isValid = spec.isBidRequestValid(invalidBid);
+
+      expect(isValid).to.equal(false);
+    });
+
+    it('should reject bid if dimension is not a string', function () {
+      let invalidBid = {
+        bidder: 'iprom',
+        params: {
+          id: '1234',
+          dimension: 404,
+        }
+      };
+
+      const isValid = spec.isBidRequestValid(invalidBid);
+
+      expect(isValid).to.equal(false);
+    });
+
+    it('should reject bid if missing id', function () {
+      let invalidBid = {
+        bidder: 'iprom',
+        params: {
+          dimension: '300x250',
+        }
+      };
+
+      const isValid = spec.isBidRequestValid(invalidBid);
+
+      expect(isValid).to.equal(false);
+    });
+
+    it('should reject bid if id is not a string', function () {
+      let invalidBid = {
+        bidder: 'iprom',
+        params: {
+          id: 1234,
+          dimension: '300x250',
+        }
+      };
+
+      const isValid = spec.isBidRequestValid(invalidBid);
+
+      expect(isValid).to.equal(false);
+    });
+  });
+
+  describe('building requests', function () {
+    it('should go to correct endpoint', function () {
+      const request = spec.buildRequests(bidRequests, bidderRequest);
+
+      expect(request.method).to.exist;
+      expect(request.method).to.equal('POST');
+      expect(request.url).to.exist;
+      expect(request.url).to.equal('https://core.iprom.net/programmatic');
+    });
+
+    it('should add referer info', function () {
+      const request = spec.buildRequests(bidRequests, bidderRequest);
+      const requestparse = JSON.parse(request.data);
+
+      expect(requestparse.referer).to.exist;
+      expect(requestparse.referer.referer).to.equal('https://adserver.si/index.html');
+    });
+
+    it('should add adapter version', function () {
+      const request = spec.buildRequests(bidRequests, bidderRequest);
+      const requestparse = JSON.parse(request.data);
+
+      expect(requestparse.version).to.exist;
+    });
+
+    it('should contain id and dimension', function () {
+      const request = spec.buildRequests(bidRequests, bidderRequest);
+      const requestparse = JSON.parse(request.data);
+
+      expect(requestparse.bids[0].params.id).to.equal('1234');
+      expect(requestparse.bids[0].params.dimension).to.equal('300x250');
+    });
+  });
+
+  describe('handling responses', function () {
+    it('should return complete bid response', function () {
+      const serverResponse = {
+        body: [{
+          requestId: '29a72b151f7bd3',
+          cpm: 0.5,
+          width: '300',
+          height: '250',
+          creativeId: 1234,
+          ad: '<html><head><title>Iprom Header bidding example</title></head><body><img src="https://iprom.si/files/2015/08/iprom-logo.svg"></body></html>',
+          aDomains: ['https://example.com'],
+        }
+        ]};
+
+      const request = spec.buildRequests(bidRequests, bidderRequest);
+      const bids = spec.interpretResponse(serverResponse, request);
+
+      expect(bids).to.be.lengthOf(1);
+      expect(bids[0].requestId).to.equal('29a72b151f7bd3');
+      expect(bids[0].cpm).to.equal(0.5);
+      expect(bids[0].width).to.equal('300');
+      expect(bids[0].height).to.equal('250');
+      expect(bids[0].ad).to.have.length.above(1);
+      expect(bids[0].meta.advertiserDomains).to.deep.equal(['https://example.com']);
+    });
+
+    it('should return empty bid response', function () {
+      const emptyServerResponse = {
+        body: []
+      };
+
+      const request = spec.buildRequests(bidRequests, bidderRequest);
+      const bids = spec.interpretResponse(emptyServerResponse, request);
+
+      expect(bids).to.be.lengthOf(0);
+    });
+  });
+});

package/test/spec/modules/ixBidAdapter_spec.js

@@ -1377,6 +1377,11 @@ describe('IndexexchangeAdapter', function () {
       expect(requestUrl).to.equal(IX_SECURE_ENDPOINT);
     });
 
+    it('auction type should be set correctly', function () {
+      const at = JSON.parse(query.r).at;
+      expect(at).to.equal(1);
+    })
+
     it('query object (version, siteID and request) should be correct', function () {
       expect(query.v).to.equal(BANNER_ENDPOINT_VERSION);
       expect(query.s).to.equal(DEFAULT_BANNER_VALID_BID[0].params.siteId);
@@ -1400,16 +1405,16 @@ describe('IndexexchangeAdapter', function () {
         }
       };
       const requests = spec.buildRequests(validBids, DEFAULT_OPTION);
-      const { dfp_ad_unit_code } = JSON.parse(requests[0].data.r).imp[0].banner.format[0].ext;
+      const { ext: { dfp_ad_unit_code } } = JSON.parse(requests[0].data.r).imp[0];
       expect(dfp_ad_unit_code).to.equal(AD_UNIT_CODE);
     });
 
     it('should not send dfp_adunit_code in request if ortb2Imp.ext.data.adserver.adslot does not exists', function () {
       const validBids = utils.deepClone(DEFAULT_BANNER_VALID_BID);
       const requests = spec.buildRequests(validBids, DEFAULT_OPTION);
-      const { dfp_ad_unit_code } = JSON.parse(requests[0].data.r).imp[0].banner.format[0].ext;
+      const { ext } = JSON.parse(requests[0].data.r).imp[0];
 
-      expect(dfp_ad_unit_code).to.not.exist;
+      expect(ext).to.not.exist;
     });
 
     it('payload should have correct format and value', function () {
@@ -1929,6 +1934,11 @@ describe('IndexexchangeAdapter', function () {
       expect(query.nf).to.equal(1);
     });
 
+    it('auction type should be set correctly', function () {
+      const at = JSON.parse(query.r).at;
+      expect(at).to.equal(1);
+    })
+
     it('impression should have correct format and value', function () {
       const impression = JSON.parse(query.r).imp[0];
       const sidValue = utils.parseGPTSingleSizeArray(DEFAULT_VIDEO_VALID_BID[0].params.size);