prebid.js 5.14.0 → 5.18.0

package/test/spec/modules/rubiconAnalyticsAdapter_spec.js

@@ -168,8 +168,8 @@ const floorMinRequest = {
     'zoneId': '335918',
     'userId': '12346',
     'keywords': ['a', 'b', 'c'],
-    'inventory': {'rating': '4-star', 'prodtype': 'tech'},
-    'visitor': {'ucat': 'new', 'lastsearch': 'iphone'},
+    'inventory': { 'rating': '4-star', 'prodtype': 'tech' },
+    'visitor': { 'ucat': 'new', 'lastsearch': 'iphone' },
     'position': 'atf'
   },
   'mediaTypes': {
@@ -195,24 +195,24 @@ const MOCK = {
     'auctionId': '25c6d7f5-699a-4bfc-87c9-996f915341fa',
     'timestamp': 1519767010567,
     'auctionStatus': 'inProgress',
-    'adUnits': [ {
+    'adUnits': [{
       'code': '/19968336/header-bid-tag1',
       'sizes': [[640, 480]],
-      'bids': [ {
+      'bids': [{
         'bidder': 'rubicon',
         'params': {
           'accountId': 1001, 'siteId': 113932, 'zoneId': 535512
         }
-      } ],
+      }],
       'transactionId': 'ca4af27a-6d02-4f90-949d-d5541fa12014'
     }
     ],
     'adUnitCodes': ['/19968336/header-bid-tag1'],
-    'bidderRequests': [ {
+    'bidderRequests': [{
       'bidderCode': 'rubicon',
       'auctionId': '25c6d7f5-699a-4bfc-87c9-996f915341fa',
       'bidderRequestId': '1be65d7958826a',
-      'bids': [ {
+      'bids': [{
         'bidder': 'rubicon',
         'params': {
           'accountId': 1001, 'siteId': 113932, 'zoneId': 535512
@@ -259,7 +259,7 @@ const MOCK = {
           'userId': '12346',
           'keywords': ['a', 'b', 'c'],
           'inventory': 'test',
-          'visitor': {'ucat': 'new', 'lastsearch': 'iphone'},
+          'visitor': { 'ucat': 'new', 'lastsearch': 'iphone' },
           'position': 'btf',
           'video': {
             'language': 'en',
@@ -296,8 +296,8 @@ const MOCK = {
           'zoneId': '335918',
           'userId': '12346',
           'keywords': ['a', 'b', 'c'],
-          'inventory': {'rating': '4-star', 'prodtype': 'tech'},
-          'visitor': {'ucat': 'new', 'lastsearch': 'iphone'},
+          'inventory': { 'rating': '4-star', 'prodtype': 'tech' },
+          'visitor': { 'ucat': 'new', 'lastsearch': 'iphone' },
           'position': 'atf'
         },
         'mediaTypes': {
@@ -655,10 +655,10 @@ describe('rubicon analytics adapter', function () {
     expect(utils.logError.called).to.equal(true);
   });
 
-  describe('config subscribe', function() {
+  describe('config subscribe', function () {
     it('should update the pvid if user asks', function () {
       expect(utils.generateUUID.called).to.equal(false);
-      config.setConfig({rubicon: {updatePageView: true}});
+      config.setConfig({ rubicon: { updatePageView: true } });
       expect(utils.generateUUID.called).to.equal(true);
     });
     it('should merge in and preserve older set configs', function () {
@@ -859,7 +859,7 @@ describe('rubicon analytics adapter', function () {
         criteoId: 'sadfe4334',
         lotamePanoramaId: 'asdf3gf4eg',
         pubcid: 'dsfa4545-svgdfs5',
-        sharedId: {id1: 'asdf', id2: 'sadf4344'}
+        sharedId: { id1: 'asdf', id2: 'sadf4344' }
       };
 
       events.emit(AUCTION_INIT, auctionInit);
@@ -881,10 +881,10 @@ describe('rubicon analytics adapter', function () {
 
       expect(message.auctions[0].user).to.deep.equal({
         ids: [
-          {provider: 'criteoId', 'hasId': true},
-          {provider: 'lotamePanoramaId', 'hasId': true},
-          {provider: 'pubcid', 'hasId': true},
-          {provider: 'sharedId', 'hasId': true},
+          { provider: 'criteoId', 'hasId': true },
+          { provider: 'lotamePanoramaId', 'hasId': true },
+          { provider: 'pubcid', 'hasId': true },
+          { provider: 'sharedId', 'hasId': true },
         ]
       });
     });
@@ -1206,7 +1206,7 @@ describe('rubicon analytics adapter', function () {
     describe('with session handling', function () {
       const expectedPvid = STUBBED_UUID.slice(0, 8);
       beforeEach(function () {
-        config.setConfig({rubicon: {updatePageView: true}});
+        config.setConfig({ rubicon: { updatePageView: true } });
       });
 
       it('should not log any session data if local storage is not enabled', function () {
@@ -1230,12 +1230,14 @@ describe('rubicon analytics adapter', function () {
       });
 
       it('should should pass along custom rubicon kv and pvid when defined', function () {
-        config.setConfig({rubicon: {
-          fpkvs: {
-            source: 'fb',
-            link: 'email'
+        config.setConfig({
+          rubicon: {
+            fpkvs: {
+              source: 'fb',
+              link: 'email'
+            }
           }
-        }});
+        });
         performStandardAuction();
         expect(server.requests.length).to.equal(1);
         let request = server.requests[0];
@@ -1245,22 +1247,24 @@ describe('rubicon analytics adapter', function () {
         let expectedMessage = utils.deepClone(ANALYTICS_MESSAGE);
         expectedMessage.session.pvid = STUBBED_UUID.slice(0, 8);
         expectedMessage.fpkvs = [
-          {key: 'source', value: 'fb'},
-          {key: 'link', value: 'email'}
+          { key: 'source', value: 'fb' },
+          { key: 'link', value: 'email' }
         ]
         expect(message).to.deep.equal(expectedMessage);
       });
 
       it('should convert kvs to strings before sending', function () {
-        config.setConfig({rubicon: {
-          fpkvs: {
-            number: 24,
-            boolean: false,
-            string: 'hello',
-            array: ['one', 2, 'three'],
-            object: {one: 'two'}
+        config.setConfig({
+          rubicon: {
+            fpkvs: {
+              number: 24,
+              boolean: false,
+              string: 'hello',
+              array: ['one', 2, 'three'],
+              object: { one: 'two' }
+            }
           }
-        }});
+        });
         performStandardAuction();
         expect(server.requests.length).to.equal(1);
         let request = server.requests[0];
@@ -1270,24 +1274,26 @@ describe('rubicon analytics adapter', function () {
         let expectedMessage = utils.deepClone(ANALYTICS_MESSAGE);
         expectedMessage.session.pvid = STUBBED_UUID.slice(0, 8);
         expectedMessage.fpkvs = [
-          {key: 'number', value: '24'},
-          {key: 'boolean', value: 'false'},
-          {key: 'string', value: 'hello'},
-          {key: 'array', value: 'one,2,three'},
-          {key: 'object', value: '[object Object]'}
+          { key: 'number', value: '24' },
+          { key: 'boolean', value: 'false' },
+          { key: 'string', value: 'hello' },
+          { key: 'array', value: 'one,2,three' },
+          { key: 'object', value: '[object Object]' }
         ]
         expect(message).to.deep.equal(expectedMessage);
       });
 
       it('should use the query utm param rubicon kv value and pass updated kv and pvid when defined', function () {
-        sandbox.stub(utils, 'getWindowLocation').returns({'search': '?utm_source=other', 'pbjs_debug': 'true'});
+        sandbox.stub(utils, 'getWindowLocation').returns({ 'search': '?utm_source=other', 'pbjs_debug': 'true' });
 
-        config.setConfig({rubicon: {
-          fpkvs: {
-            source: 'fb',
-            link: 'email'
+        config.setConfig({
+          rubicon: {
+            fpkvs: {
+              source: 'fb',
+              link: 'email'
+            }
           }
-        }});
+        });
         performStandardAuction();
         expect(server.requests.length).to.equal(1);
         let request = server.requests[0];
@@ -1297,8 +1303,8 @@ describe('rubicon analytics adapter', function () {
         let expectedMessage = utils.deepClone(ANALYTICS_MESSAGE);
         expectedMessage.session.pvid = STUBBED_UUID.slice(0, 8);
         expectedMessage.fpkvs = [
-          {key: 'source', value: 'other'},
-          {key: 'link', value: 'email'}
+          { key: 'source', value: 'other' },
+          { key: 'link', value: 'email' }
         ]
 
         message.fpkvs.sort((left, right) => left.key < right.key);
@@ -1318,11 +1324,13 @@ describe('rubicon analytics adapter', function () {
         };
         getDataFromLocalStorageStub.withArgs('rpaSession').returns(btoa(JSON.stringify(inputlocalStorage)));
 
-        config.setConfig({rubicon: {
-          fpkvs: {
-            link: 'email' // should merge this with what is in the localStorage!
+        config.setConfig({
+          rubicon: {
+            fpkvs: {
+              link: 'email' // should merge this with what is in the localStorage!
+            }
           }
-        }});
+        });
         performStandardAuction();
         expect(server.requests.length).to.equal(1);
         let request = server.requests[0];
@@ -1337,8 +1345,8 @@ describe('rubicon analytics adapter', function () {
           pvid: expectedPvid
         }
         expectedMessage.fpkvs = [
-          {key: 'source', value: 'tw'},
-          {key: 'link', value: 'email'}
+          { key: 'source', value: 'tw' },
+          { key: 'link', value: 'email' }
         ]
         expect(message).to.deep.equal(expectedMessage);
 
@@ -1360,7 +1368,7 @@ describe('rubicon analytics adapter', function () {
       });
 
       it('should overwrite matching localstorge value and use its remaining values', function () {
-        sandbox.stub(utils, 'getWindowLocation').returns({'search': '?utm_source=fb&utm_click=dog'});
+        sandbox.stub(utils, 'getWindowLocation').returns({ 'search': '?utm_source=fb&utm_click=dog' });
 
         // set some localStorage
         let inputlocalStorage = {
@@ -1372,11 +1380,13 @@ describe('rubicon analytics adapter', function () {
         };
         getDataFromLocalStorageStub.withArgs('rpaSession').returns(btoa(JSON.stringify(inputlocalStorage)));
 
-        config.setConfig({rubicon: {
-          fpkvs: {
-            link: 'email' // should merge this with what is in the localStorage!
+        config.setConfig({
+          rubicon: {
+            fpkvs: {
+              link: 'email' // should merge this with what is in the localStorage!
+            }
           }
-        }});
+        });
         performStandardAuction();
         expect(server.requests.length).to.equal(1);
         let request = server.requests[0];
@@ -1391,9 +1401,9 @@ describe('rubicon analytics adapter', function () {
           pvid: expectedPvid
         }
         expectedMessage.fpkvs = [
-          {key: 'source', value: 'fb'},
-          {key: 'link', value: 'email'},
-          {key: 'click', value: 'dog'}
+          { key: 'source', value: 'fb' },
+          { key: 'link', value: 'email' },
+          { key: 'click', value: 'dog' }
         ]
 
         message.fpkvs.sort((left, right) => left.key < right.key);
@@ -1429,11 +1439,13 @@ describe('rubicon analytics adapter', function () {
         };
         getDataFromLocalStorageStub.withArgs('rpaSession').returns(btoa(JSON.stringify(inputlocalStorage)));
 
-        config.setConfig({rubicon: {
-          fpkvs: {
-            link: 'email' // should merge this with what is in the localStorage!
+        config.setConfig({
+          rubicon: {
+            fpkvs: {
+              link: 'email' // should merge this with what is in the localStorage!
+            }
           }
-        }});
+        });
 
         performStandardAuction();
         expect(server.requests.length).to.equal(1);
@@ -1447,7 +1459,7 @@ describe('rubicon analytics adapter', function () {
 
         // the saved fpkvs should have been thrown out since session expired
         expectedMessage.fpkvs = [
-          {key: 'link', value: 'email'}
+          { key: 'link', value: 'email' }
         ]
         expect(message).to.deep.equal(expectedMessage);
 
@@ -1479,11 +1491,13 @@ describe('rubicon analytics adapter', function () {
         };
         getDataFromLocalStorageStub.withArgs('rpaSession').returns(btoa(JSON.stringify(inputlocalStorage)));
 
-        config.setConfig({rubicon: {
-          fpkvs: {
-            link: 'email' // should merge this with what is in the localStorage!
+        config.setConfig({
+          rubicon: {
+            fpkvs: {
+              link: 'email' // should merge this with what is in the localStorage!
+            }
           }
-        }});
+        });
 
         performStandardAuction();
         expect(server.requests.length).to.equal(1);
@@ -1497,7 +1511,7 @@ describe('rubicon analytics adapter', function () {
 
         // the saved fpkvs should have been thrown out since session expired
         expectedMessage.fpkvs = [
-          {key: 'link', value: 'email'}
+          { key: 'link', value: 'email' }
         ]
         expect(message).to.deep.equal(expectedMessage);
 
@@ -1523,7 +1537,7 @@ describe('rubicon analytics adapter', function () {
       let gptSlotRenderEnded0, gptSlotRenderEnded1;
       beforeEach(function () {
         mockGpt.enable();
-        gptSlot0 = mockGpt.makeSlot({code: '/19968336/header-bid-tag-0'});
+        gptSlot0 = mockGpt.makeSlot({ code: '/19968336/header-bid-tag-0' });
         gptSlotRenderEnded0 = {
           eventName: 'slotRenderEnded',
           params: {
@@ -1535,7 +1549,7 @@ describe('rubicon analytics adapter', function () {
           }
         };
 
-        gptSlot1 = mockGpt.makeSlot({code: '/19968336/header-bid-tag1'});
+        gptSlot1 = mockGpt.makeSlot({ code: '/19968336/header-bid-tag1' });
         gptSlotRenderEnded1 = {
           eventName: 'slotRenderEnded',
           params: {
@@ -1971,6 +1985,7 @@ describe('rubicon analytics adapter', function () {
       let timedOutBid = message.auctions[0].adUnits[0].bids[0];
       expect(timedOutBid.status).to.equal('error');
       expect(timedOutBid.error.code).to.equal('timeout-error');
+      expect(timedOutBid.error.description).to.equal('prebid.js timeout');
       expect(timedOutBid).to.not.have.property('bidResponse');
     });
 
@@ -2051,7 +2066,7 @@ describe('rubicon analytics adapter', function () {
 
       // Now add the bidResponse hook which hooks on the currenct conversion function onto the bid response
       let innerBid;
-      addBidResponseHook(function(adCodeId, bid) {
+      addBidResponseHook(function (adCodeId, bid) {
         innerBid = bid;
       }, 'elementId', bidCopy);
 
@@ -2064,9 +2079,11 @@ describe('rubicon analytics adapter', function () {
 
   describe('config with integration type', () => {
     it('should use the integration type provided in the config instead of the default', () => {
-      config.setConfig({rubicon: {
-        int_type: 'testType'
-      }})
+      config.setConfig({
+        rubicon: {
+          int_type: 'testType'
+        }
+      })
 
       rubiconAnalyticsAdapter.enableAnalytics({
         options: {
@@ -2088,11 +2105,13 @@ describe('rubicon analytics adapter', function () {
 
   describe('wrapper details passed in', () => {
     it('should correctly pass in the wrapper details if provided', () => {
-      config.setConfig({rubicon: {
-        wrapperName: '1001_wrapperName_exp.4',
-        wrapperFamily: '1001_wrapperName',
-        rule_name: 'na-mobile'
-      }});
+      config.setConfig({
+        rubicon: {
+          wrapperName: '1001_wrapperName_exp.4',
+          wrapperFamily: '1001_wrapperName',
+          rule_name: 'na-mobile'
+        }
+      });
 
       rubiconAnalyticsAdapter.enableAnalytics({
         options: {

package/test/spec/modules/rubiconAnalyticsSchema.json

@@ -263,7 +263,9 @@
         },
         "isSlotEmpty": {
           "type": "boolean",
-          "enum": [true]
+          "enum": [
+            true
+          ]
         }
       }
     },
@@ -369,6 +371,7 @@
         },
         "error": {
           "type": "object",
+          "additionalProperties": false,
           "required": [
             "code"
           ],
@@ -448,4 +451,4 @@
       }
     }
   }
-}
+}

package/test/spec/modules/seedingAllianceAdapter_spec.js

@@ -0,0 +1,186 @@
+// jshint esversion: 6, es3: false, node: true
+import {assert, expect} from 'chai';
+import {spec} from 'modules/seedingAllianceBidAdapter.js';
+import { NATIVE } from 'src/mediaTypes.js';
+import { config } from 'src/config.js';
+
+describe('SeedingAlliance adapter', function () {
+  let serverResponse, bidRequest, bidResponses;
+  let bid = {
+    'bidder': 'seedingAlliance',
+    'params': {
+      'adUnitId': '1hq8'
+    }
+  };
+
+  describe('isBidRequestValid', function () {
+    it('should return true when required params found', function () {
+      assert(spec.isBidRequestValid(bid));
+    });
+
+    it('should return false when AdUnitId is not set', function () {
+      delete bid.params.adUnitId;
+      assert.isFalse(spec.isBidRequestValid(bid));
+    });
+  });
+
+  describe('buildRequests', function () {
+    it('should send request with correct structure', function () {
+      let validBidRequests = [{
+        bidId: 'bidId',
+        params: {}
+      }];
+
+      let request = spec.buildRequests(validBidRequests, { refererInfo: { referer: 'page' } });
+
+      assert.equal(request.method, 'POST');
+      assert.ok(request.data);
+    });
+
+    it('should have default request structure', function () {
+      let keys = 'site,device,cur,imp,user,regs'.split(',');
+      let validBidRequests = [{
+        bidId: 'bidId',
+        params: {}
+      }];
+      let request = JSON.parse(spec.buildRequests(validBidRequests, { refererInfo: { referer: 'page' } }).data);
+      let data = Object.keys(request);
+
+      assert.deepEqual(keys, data);
+    });
+
+    it('Verify the auction ID', function () {
+      let validBidRequests = [{
+        bidId: 'bidId',
+        params: {},
+        auctionId: 'auctionId'
+      }];
+      let request = JSON.parse(spec.buildRequests(validBidRequests, { refererInfo: { referer: 'page' }, auctionId: validBidRequests[0].auctionId }).data);
+
+      assert.equal(request.id, validBidRequests[0].auctionId);
+    });
+
+    it('Verify the device', function () {
+      let validBidRequests = [{
+        bidId: 'bidId',
+        params: {}
+      }];
+      let request = JSON.parse(spec.buildRequests(validBidRequests, { refererInfo: { referer: 'page' } }).data);
+
+      assert.equal(request.device.ua, navigator.userAgent);
+    });
+
+    it('Verify native asset ids', function () {
+      let validBidRequests = [{
+        bidId: 'bidId',
+        params: {},
+        nativeParams: {
+          body: {
+            required: true,
+            len: 350
+          },
+          image: {
+            required: true
+          },
+          title: {
+            required: true
+          },
+          sponsoredBy: {
+            required: true
+          },
+          cta: {
+            required: true
+          },
+          icon: {
+            required: true
+          }
+        }
+      }];
+
+      let assets = JSON.parse(spec.buildRequests(validBidRequests, { refererInfo: { referer: 'page' } }).data).imp[0].native.request.assets;
+
+      assert.equal(assets[0].id, 1);
+      assert.equal(assets[1].id, 3);
+      assert.equal(assets[2].id, 0);
+      assert.equal(assets[3].id, 2);
+      assert.equal(assets[4].id, 4);
+      assert.equal(assets[5].id, 5);
+    });
+  });
+
+  describe('interpretResponse', function () {
+    const goodResponse = {
+      body: {
+        cur: 'EUR',
+        id: '4b516b80-886e-4ec0-82ae-9209e6d625fb',
+        seatbid: [
+          {
+          	seat: 'seedingAlliance',
+          	bid: [{
+              adm: {
+            	native: {
+            		assets: [
+            			{id: 0, title: {text: 'this is a title'}}
+            		],
+            		imptrackers: ['https://domain.for/imp/tracker?price=${AUCTION_PRICE}'],
+            		link: {
+            			clicktrackers: ['https://domain.for/imp/tracker?price=${AUCTION_PRICE}'],
+            			url: 'https://domain.for/ad/'
+            		}
+            	}
+              },
+              impid: 1,
+              price: 0.55
+            }]
+          }
+        ]
+      }
+    };
+    const badResponse = { body: {
+      cur: 'EUR',
+      id: '4b516b80-886e-4ec0-82ae-9209e6d625fb',
+      seatbid: []
+    }};
+
+    const bidRequest = {
+      data: {},
+      bids: [{ bidId: 'bidId1' }]
+    };
+
+    it('should return null if body is missing or empty', function () {
+      const result = spec.interpretResponse(badResponse, bidRequest);
+      assert.equal(result.length, 0);
+
+      delete badResponse.body
+
+      const result1 = spec.interpretResponse(badResponse, bidRequest);
+      assert.equal(result.length, 0);
+    });
+
+    it('should return the correct params', function () {
+      const result = spec.interpretResponse(goodResponse, bidRequest);
+      const bid = goodResponse.body.seatbid[0].bid[0];
+
+      assert.deepEqual(result[0].currency, goodResponse.body.cur);
+      assert.deepEqual(result[0].requestId, bidRequest.bids[0].bidId);
+      assert.deepEqual(result[0].cpm, bid.price);
+      assert.deepEqual(result[0].creativeId, bid.crid);
+      assert.deepEqual(result[0].mediaType, 'native');
+      assert.deepEqual(result[0].bidderCode, 'seedingAlliance');
+    });
+
+    it('should return the correct tracking links', function () {
+      const result = spec.interpretResponse(goodResponse, bidRequest);
+      const bid = goodResponse.body.seatbid[0].bid[0];
+      const regExpPrice = new RegExp('price=' + bid.price);
+
+      result[0].native.clickTrackers.forEach(function (clickTracker) {
+        	assert.ok(clickTracker.search(regExpPrice) > -1);
+      });
+
+      result[0].native.impressionTrackers.forEach(function (impTracker) {
+        	assert.ok(impTracker.search(regExpPrice) > -1);
+      });
+    });
+  });
+});