prebid.js 5.17.0 → 6.0.0

package/test/spec/modules/cwireBidAdapter_spec.js

@@ -0,0 +1,246 @@
+import { expect } from 'chai';
+import * as utils from '../../../src/utils.js';
+import {
+  spec,
+  CW_PAGE_VIEW_ID,
+  ENDPOINT_URL,
+  RENDERER_URL,
+} from '../../../modules/cwireBidAdapter.js';
+import * as prebidGlobal from 'src/prebidGlobal.js';
+
+// ------------------------------------
+// Bid Request Builder
+// ------------------------------------
+
+const BID_DEFAULTS = {
+  request: {
+    bidder: 'cwire',
+    auctionId: 'aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee',
+    transactionId: 'txaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee',
+    bidId: 'bid123445',
+    bidderRequestId: 'brid12345',
+    code: 'original-div',
+  },
+  params: {
+    placementId: 123456,
+    pageId: 777,
+    adUnitElementId: 'target-div'
+  },
+  sizes: [[300, 250], [1, 1]],
+};
+
+const BidderRequestBuilder = function BidderRequestBuilder(options) {
+  const defaults = {
+    bidderCode: 'cwire',
+    auctionId: BID_DEFAULTS.request.auctionId,
+    bidderRequestId: BID_DEFAULTS.request.bidderRequestId,
+    transactionId: BID_DEFAULTS.request.transactionId,
+    timeout: 3000,
+    refererInfo: {
+      numIframes: 0,
+      reachedTop: true,
+      referer: 'http://test.io/index.html?pbjs_debug=true'
+    }
+  };
+
+  const request = {
+    ...defaults,
+    ...options
+  };
+
+  this.build = () => request;
+};
+
+const BidRequestBuilder = function BidRequestBuilder(options, deleteKeys) {
+  const defaults = JSON.parse(JSON.stringify(BID_DEFAULTS));
+
+  const request = {
+    ...defaults.request,
+    ...options
+  };
+
+  if (request && utils.isArray(deleteKeys)) {
+    deleteKeys.forEach((k) => {
+      delete request[k];
+    })
+  }
+
+  this.withParams = (options, deleteKeys) => {
+    request.params = {
+      ...defaults.params,
+      ...options
+    };
+    if (request && utils.isArray(deleteKeys)) {
+      deleteKeys.forEach((k) => {
+        delete request.params[k];
+      })
+    }
+    return this;
+  };
+
+  this.build = () => request;
+};
+
+describe('C-WIRE bid adapter', () => {
+  let utilsMock;
+  let sandbox;
+
+  beforeEach(() => {
+    utilsMock = sinon.mock(utils);
+    sandbox = sinon.createSandbox();
+  });
+
+  afterEach(() => {
+    utilsMock.restore();
+    sandbox.restore();
+  });
+
+  // START TESTING
+  describe('C-WIRE - isBidRequestValid', function () {
+    it('should return true when required params found', function () {
+      const bid01 = new BidRequestBuilder().withParams().build();
+      expect(spec.isBidRequestValid(bid01)).to.equal(true);
+    });
+
+    it('should fail if there is no placementId', function () {
+      const bid01 = new BidRequestBuilder().withParams().build();
+      delete bid01.params.placementId
+      expect(spec.isBidRequestValid(bid01)).to.equal(false);
+    });
+
+    it('should fail if invalid placementId type', function () {
+      const bid01 = new BidRequestBuilder().withParams().build();
+      delete bid01.params.placementId;
+      bid01.placementId = '322';
+      expect(spec.isBidRequestValid(bid01)).to.equal(false);
+    });
+
+    it('should fail if there is no pageId', function () {
+      const bid01 = new BidRequestBuilder().withParams().build();
+      delete bid01.params.pageId
+      expect(spec.isBidRequestValid(bid01)).to.equal(false);
+    });
+
+    it('should fail if invalid pageId type', function () {
+      const bid01 = new BidRequestBuilder().withParams().build();
+      delete bid01.params.pageId;
+      bid01.params.pageId = '3320';
+      expect(spec.isBidRequestValid(bid01)).to.equal(false);
+    });
+
+    it('should use params.adUnitElementId if provided', function () {
+      const bid01 = new BidRequestBuilder().withParams().build();
+
+      expect(spec.isBidRequestValid(bid01)).to.equal(true);
+      expect(bid01.params.adUnitElementId).to.exist;
+      expect(bid01.params.adUnitElementId).to.equal('target-div');
+    });
+
+    it('should use default adUnitCode if no adUnitElementId provided', function () {
+      const bid01 = new BidRequestBuilder().withParams({}, ['adUnitElementId']).build();
+      expect(spec.isBidRequestValid(bid01)).to.equal(true);
+      expect(bid01.params.adUnitElementId).to.exist;
+      expect(bid01.params.adUnitElementId).to.equal('original-div');
+    });
+  });
+
+  describe('C-WIRE - buildRequests()', function () {
+    it('creates a valid request', function () {
+      const bid01 = new BidRequestBuilder({
+        mediaTypes: {
+          banner: {
+            sizes: [[1, 1]],
+          }
+        }
+      }).withParams().build();
+      const bidderRequest01 = new BidderRequestBuilder().build();
+
+      const requests = spec.buildRequests([bid01], bidderRequest01);
+      expect(requests.data.slots.length).to.equal(1);
+      expect(requests.data.cwid).to.be.null;
+      expect(requests.data.slots[0].sizes[0]).to.equal('1x1');
+    });
+  });
+
+  describe('C-WIRE - interpretResponse()', function () {
+    const serverResponse = {
+      body: {
+        bids: [{
+          html: '<div><h2>AD CONTENT</h2></div>',
+          currency: 'CHF',
+          cpm: 43.37,
+          dimensions: [1, 1],
+          netRevenue: true,
+          creativeId: '1337',
+          requestId: BID_DEFAULTS.request.bidId,
+          ttl: 3500,
+        }],
+      }
+    };
+
+    const expectedResponse = [{
+      ad: JSON.parse(JSON.stringify(serverResponse.body.bids[0].html)),
+      bidderCode: BID_DEFAULTS.request.bidder,
+      cpm: JSON.parse(JSON.stringify(serverResponse.body.bids[0].cpm)),
+      creativeId: JSON.parse(JSON.stringify(serverResponse.body.bids[0].creativeId)),
+      currency: JSON.parse(JSON.stringify(serverResponse.body.bids[0].currency)),
+      height: JSON.parse(JSON.stringify(serverResponse.body.bids[0].dimensions[0])),
+      width: JSON.parse(JSON.stringify(serverResponse.body.bids[0].dimensions[1])),
+      netRevenue: JSON.parse(JSON.stringify(serverResponse.body.bids[0].netRevenue)),
+      requestId: JSON.parse(JSON.stringify(serverResponse.body.bids[0].requestId)),
+      ttl: JSON.parse(JSON.stringify(serverResponse.body.bids[0].ttl)),
+      meta: {
+        advertiserDomains: [],
+      },
+      mediaType: 'banner',
+    }]
+
+    it('correctly parses response', function () {
+      const bid01 = new BidRequestBuilder({
+        mediaTypes: {
+          banner: {
+            sizes: [[1, 1]],
+          }
+        }
+      }).withParams().build();
+
+      const bidderRequest01 = new BidderRequestBuilder().build();
+      const requests = spec.buildRequests([bid01], bidderRequest01);
+
+      const response = spec.interpretResponse(serverResponse, requests);
+      expect(response).to.deep.equal(expectedResponse);
+    });
+
+    it('attaches renderer', function () {
+      const bid01 = new BidRequestBuilder({
+        mediaTypes: {
+          video: {
+            playerSize: [[640, 480]],
+            context: 'outstream',
+          }
+        }
+      }).withParams().build();
+      const bidderRequest01 = new BidderRequestBuilder().build();
+
+      const _serverResponse = utils.deepClone(serverResponse);
+      _serverResponse.body.bids[0].vastXml = '<xml></xml>';
+
+      const _expectedResponse = utils.deepClone(expectedResponse);
+      _expectedResponse[0].mediaType = 'video';
+      _expectedResponse[0].videoScript = JSON.parse(JSON.stringify(_serverResponse.body.bids[0].html));
+      _expectedResponse[0].vastXml = JSON.parse(JSON.stringify(_serverResponse.body.bids[0].vastXml));
+      delete _expectedResponse[0].ad;
+
+      const requests = spec.buildRequests([bid01], bidderRequest01);
+      expect(requests.data.slots[0].sizes).to.deep.equal(['640x480']);
+
+      const response = spec.interpretResponse(_serverResponse, requests);
+      expect(response[0].renderer).to.exist;
+      expect(response[0].renderer.url).to.equals(RENDERER_URL);
+      expect(response[0].renderer.loaded).to.equals(false);
+
+      delete response[0].renderer;
+      expect(response).to.deep.equal(_expectedResponse);
+    });
+  });
+});

package/test/spec/modules/deepintentBidAdapter_spec.js

@@ -3,8 +3,8 @@ import {spec} from 'modules/deepintentBidAdapter.js';
 import * as utils from '../../../src/utils.js';
 
 describe('Deepintent adapter', function () {
-  let request;
-  let bannerResponse;
+  let request, videoBidRequests;
+  let bannerResponse, videoBidResponse, invalidResponse;
 
   beforeEach(function () {
     request = [
@@ -32,6 +32,38 @@ describe('Deepintent adapter', function () {
         }
       }
     ];
+    videoBidRequests =
+    [
+      {
+        code: 'video1',
+        mediaTypes: {
+          video: {
+            playerSize: [640, 480],
+            context: 'instream'
+          }
+        },
+        bidder: 'deepintent',
+        bidId: '22bddb28db77d',
+        params: {
+          tagId: '100013',
+          video: {
+            mimes: ['video/mp4', 'video/x-flv'],
+            skippable: true,
+            testwrongparam: 3,
+            testwrongparam1: 'wrong',
+            minduration: 5,
+            maxduration: 30,
+            startdelay: 5,
+            playbackmethod: [1, 3],
+            api: [1, 2],
+            protocols: [2, 3],
+            battr: [13, 14],
+            minbitrate: 10,
+            maxbitrate: 10
+          }
+        }
+      }
+    ];
     bannerResponse = {
       'body': {
         'id': '303e1fae-9677-41e2-9a92-15a23445363f',
@@ -53,7 +85,47 @@ describe('Deepintent adapter', function () {
         }],
         'bidid': '0b08b09f-aaa1-4c14-b1c8-7debb1a7c1cd'
       }
-    }
+    };
+    invalidResponse = {
+      'body': {
+        'id': '303e1fae-9677-41e2-9a92-15a23445363f',
+        'seatbid': [{
+          'bid': [{
+            'id': '11447bb1-a266-470d-b0d7-8810f5b1b75f',
+            'impid': 'a7e92b9b-d9db-4de8-9c3f-f90737335445',
+            'price': 0.6,
+            'adid': '10001',
+            'adm': 'invalid response',
+            'adomain': ['deepintent.com'],
+            'cid': '103389',
+            'crid': '13665',
+            'w': 300,
+            'h': 250,
+            'dealId': 'dee_12312stdszzsx'
+          }],
+          'seat': '10000'
+        }],
+        'bidid': '0b08b09f-aaa1-4c14-b1c8-7debb1a7c1cd'
+      }
+    };
+    videoBidResponse = {
+      'body': {
+        'id': '93D3BAD6-E2E2-49FB-9D89-920B1761C865',
+        'seatbid': [{
+          'bid': [{
+            'id': '74858439-49D7-4169-BA5D-44A046315B2F',
+            'impid': '22bddb28db77d',
+            'price': 1.3,
+            'adm': '<VAST version="3.0"><Ad id="601364"><InLine><AdSystem>Acudeo Compatible</AdSystem><AdTitle>VAST 2.0 Instream Test 1</AdTitle><Description>VAST 2.0 Instream Test 1</Description><Impression><![CDATA[http://172.16.4.213/AdServer/AdDisplayTrackerServlet?operId=1&pubId=5890&siteId=47163&adId=1405268&adType=13&adServerId=243&kefact=70.000000&kaxefact=70.000000&kadNetFrequecy=0&kadwidth=0&kadheight=0&kadsizeid=97&kltstamp=1529929473&indirectAdId=0&adServerOptimizerId=2&ranreq=0.1&kpbmtpfact=100.000000&dcId=1&tldId=0&passback=0&svr=MADS1107&ekefact=Ad8wW91TCwCmdG0jlfjXn7Tyzh20hnTVx-m5DoNSep-RXGDr&ekaxefact=Ad8wWwRUCwAGir4Zzl1eF0bKiC-qrCV0D0yp_eE7YizB_BQk&ekpbmtpfact=Ad8wWxRUCwD7qgzwwPE2LnS5-Ou19uO5amJl1YT6-XVFvQ41&imprId=48F73E1A-7F23-443D-A53C-30EE6BBF5F7F&oid=48F73E1A-7F23-443D-A53C-30EE6BBF5F7F&crID=creative-1_1_2&ucrid=160175026529250297&campaignId=17050&creativeId=0&pctr=0.000000&wDSPByrId=511&wDspId=6&wbId=0&wrId=0&wAdvID=3170&isRTB=1&rtbId=EBCA079F-8D7C-45B8-B733-92951F670AA1&pmZoneId=zone1&pageURL=www.yahoo.com&lpu=ae.com]]></Impression><Impression>https://dsptracker.com/{PSPM}</Impression><Error><![CDATA[http://172.16.4.213/track?operId=7&p=5890&s=47163&a=1405268&wa=243&ts=1529929473&wc=17050&crId=creative-1_1_2&ucrid=160175026529250297&impid=48F73E1A-7F23-443D-A53C-30EE6BBF5F7F&advertiser_id=3170&ecpm=70.000000&er=[ERRORCODE]]]></Error><Error><![CDATA[https://Errortrack.com?p=1234&er=[ERRORCODE]]]></Error><Creatives><Creative AdID="601364"><Linear skipoffset="20%"><TrackingEvents><Tracking event="close"><![CDATA[https://mytracking.com/linear/close]]></Tracking><Tracking event="skip"><![CDATA[https://mytracking.com/linear/skip]]></Tracking><Tracking event="creativeView"><![CDATA[http://172.16.4.213/track?operId=7&p=5890&s=47163&a=1405268&wa=243&ts=1529929473&wc=17050&crId=creative-1_1_2&ucrid=160175026529250297&impid=48F73E1A-7F23-443D-A53C-30EE6BBF5F7F&advertiser_id=3170&ecpm=70.000000&e=1]]></Tracking><Tracking event="start"><![CDATA[http://172.16.4.213/track?operId=7&p=5890&s=47163&a=1405268&wa=243&ts=1529929473&wc=17050&crId=creative-1_1_2&ucrid=160175026529250297&impid=48F73E1A-7F23-443D-A53C-30EE6BBF5F7F&advertiser_id=3170&ecpm=70.000000&e=2]]></Tracking><Tracking event="midpoint"><![CDATA[http://172.16.4.213/track?operId=7&p=5890&s=47163&a=1405268&wa=243&ts=1529929473&wc=17050&crId=creative-1_1_2&ucrid=160175026529250297&impid=48F73E1A-7F23-443D-A53C-30EE6BBF5F7F&advertiser_id=3170&ecpm=70.000000&e=3]]></Tracking><Tracking event="firstQuartile"><![CDATA[http://172.16.4.213/track?operId=7&p=5890&s=47163&a=1405268&wa=243&ts=1529929473&wc=17050&crId=creative-1_1_2&ucrid=160175026529250297&impid=48F73E1A-7F23-443D-A53C-30EE6BBF5F7F&advertiser_id=3170&ecpm=70.000000&e=4]]></Tracking><Tracking event="thirdQuartile"><![CDATA[http://172.16.4.213/track?operId=7&p=5890&s=47163&a=1405268&wa=243&ts=1529929473&wc=17050&crId=creative-1_1_2&ucrid=160175026529250297&impid=48F73E1A-7F23-443D-A53C-30EE6BBF5F7F&advertiser_id=3170&ecpm=70.000000&e=5]]></Tracking><Tracking event="complete"><![CDATA[http://172.16.4.213/track?operId=7&p=5890&s=47163&a=1405268&wa=243&ts=1529929473&wc=17050&crId=creative-1_1_2&ucrid=160175026529250297&impid=48F73E1A-7F23-443D-A53C-30EE6BBF5F7F&advertiser_id=3170&ecpm=70.000000&e=6]]></Tracking></TrackingEvents><Duration>00:00:04</Duration><VideoClicks><ClickTracking><![CDATA[http://172.16.4.213/track?operId=7&p=5890&s=47163&a=1405268&wa=243&ts=1529929473&wc=17050&crId=creative-1_1_2&ucrid=160175026529250297&impid=48F73E1A-7F23-443D-A53C-30EE6BBF5F7F&advertiser_id=3170&ecpm=70.000000&e=99]]></ClickTracking><ClickThrough>https://www.deepintent.com</ClickThrough></VideoClicks><MediaFiles><MediaFile delivery="progressive" type="video/mp4" bitrate="500" width="400" height="300" scalable="true" maintainAspectRatio="true"><![CDATA[https://staging.deepintent.com:8443/video/Shashank/mediaFileHost/media/mp4-sample-2.mp4]]></MediaFile></MediaFiles></Linear></Creative></Creatives></InLine></Ad></VAST>',
+            'h': 250,
+            'w': 300,
+            'ext': {
+              'deal_channel': 6
+            }
+          }]
+        }]
+      }
+    };
   });
 
   describe('validations', function () {
@@ -88,6 +160,45 @@ describe('Deepintent adapter', function () {
         isValid = spec.isBidRequestValid(bid);
       expect(isValid).to.equals(false);
     });
+    it('should check for context if video is present', function() {
+      let bid = {
+          bidder: 'deepintent',
+          params: {
+            tagId: '12345',
+            video: {
+              mimes: ['video/mp4', 'video/x-flv'],
+              skippable: true,
+            }
+          },
+          mediaTypes: {
+            video: {
+              playerSize: [640, 480],
+              context: 'instream'
+            }
+          },
+        },
+        isValid = spec.isBidRequestValid(bid);
+      expect(isValid).to.equal(true);
+    });
+    it('should error out if context is not present and is Video', function() {
+      let bid = {
+          bidder: 'deepintent',
+          params: {
+            tagId: '12345',
+            video: {
+              mimes: ['video/mp4', 'video/x-flv'],
+              skippable: true,
+            }
+          },
+          mediaTypes: {
+            video: {
+              playerSize: [640, 480]
+            }
+          },
+        },
+        isValid = spec.isBidRequestValid(bid);
+      expect(isValid).to.equal(false);
+    })
   });
   describe('request check', function () {
     it('unmutaable bid request check', function () {
@@ -179,6 +290,28 @@ describe('Deepintent adapter', function () {
       expect(data2.regs).to.equal(undefined);
       expect(data2.user.ext).to.equal(undefined);
     });
+    it('bid request check: Video params check ', function() {
+      let bRequest = spec.buildRequests(videoBidRequests);
+      let data = JSON.parse(bRequest.data);
+      expect(data.imp[0].video).to.be.a('object');
+      expect(data.imp[0].video.minduration).to.be.a('number');
+      expect(data.imp[0].video.maxduration).to.be.a('number');
+      expect(data.imp[0].video.startdelay).to.be.a('number');
+      expect(data.imp[0].video.playbackmethod).to.be.an('array');
+      expect(data.imp[0].video.api).to.be.an('array');
+      expect(data.imp[0].video.protocols).to.be.an('array');
+      expect(data.imp[0].video.battr).to.be.an('array');
+      expect(data.imp[0].video.minbitrate).to.be.a('number');
+      expect(data.imp[0].video.maxbitrate).to.be.a('number');
+      expect(data.imp[0].video.w).to.be.a('number');
+    });
+    it('bid request param check : invalid video params', function() {
+      let bRequest = spec.buildRequests(videoBidRequests);
+      let data = JSON.parse(bRequest.data);
+      expect(data.imp[0].video).to.be.a('object');
+      expect(data.imp[0].video.testwrongparam).to.equal(undefined);
+      expect(data.imp[0].video.testwrongparam1).to.equal(undefined);
+    });
   });
   describe('user sync check', function () {
     it('user sync url check', function () {
@@ -202,10 +335,27 @@ describe('Deepintent adapter', function () {
       expect(bResponse[0].height).to.equal(bannerResponse.body.seatbid[0].bid[0].h);
       expect(bResponse[0].currency).to.equal('USD');
       expect(bResponse[0].netRevenue).to.equal(false);
+      expect(bResponse[0].mediaType).to.equal('banner');
       expect(bResponse[0].meta.advertiserDomains).to.deep.equal(['deepintent.com']);
       expect(bResponse[0].ttl).to.equal(300);
       expect(bResponse[0].creativeId).to.equal(bannerResponse.body.seatbid[0].bid[0].crid);
       expect(bResponse[0].dealId).to.equal(bannerResponse.body.seatbid[0].bid[0].dealId);
     });
+    it('bid response check: valid video bid response', function() {
+      let request = spec.buildRequests(videoBidRequests);
+      let response = spec.interpretResponse(videoBidResponse, request);
+      expect(response[0].mediaType).to.equal('video');
+      expect(response[0].vastXml).to.not.equal(undefined);
+    });
+    it('invalid bid response check ', function() {
+      let bRequest = spec.buildRequests(request);
+      let response = spec.interpretResponse(invalidResponse, bRequest);
+      expect(response[0].mediaType).to.equal(undefined);
+    });
+    it('invalid bid response check ', function() {
+      let bRequest = spec.buildRequests(videoBidRequests);
+      let response = spec.interpretResponse(invalidResponse, bRequest);
+      expect(response[0].mediaType).to.equal(undefined);
+    });
   })
 });