prebid.js 5.18.0 → 6.1.0

package/test/spec/modules/limelightDigitalBidAdapter_spec.js

@@ -299,6 +299,160 @@ describe('limelightDigitalAdapter', function () {
       expect(spec.interpretResponse(bidResponses)).to.deep.equal([ resObject ]);
     });
   });
+  describe('getUserSyncs', function () {
+    const serverResponses = [
+      {
+        body: [
+          {
+            ext: {
+              sync: {
+                iframe: 'iframeUrl',
+              }
+            }
+          },
+          {
+            ext: {
+              sync: {
+                pixel: 'pixelUrl'
+              }
+            }
+          },
+          {},
+          {
+            ext: {}
+          },
+          {
+            ext: {
+              sync: {}
+            }
+          },
+          {
+            ext: {
+              sync: {
+                iframe: 'iframeUrl2',
+                pixel: 'pixelUrl3'
+              }
+            }
+          }
+        ]
+      },
+      {
+        body: [
+          {
+            ext: {
+              sync: {
+                iframe: 'iframeUrl2',
+                pixel: 'pixelUrl2'
+              }
+            }
+          },
+          {
+            ext: {
+              sync: {
+                iframe: 'iframeUrl3',
+                pixel: 'pixelUrl3'
+              }
+            }
+          }
+        ]
+      }
+    ];
+    it('should return empty array if server responses do not contain sync urls', function () {
+      const syncOptions = {
+        iframeEnabled: true,
+        pixelEnabled: true
+      };
+      const serverResponsesWithoutSyncUrls = serverResponses.map(serverResponse => {
+        const serverResponseWithoutSyncUrls = Object.assign({}, serverResponse);
+        serverResponseWithoutSyncUrls.body = serverResponse.body.map(serverResponseBody => {
+          const serverResponseBodyWithoutSyncUrls = Object.assign({}, serverResponseBody);
+          delete serverResponseBodyWithoutSyncUrls.ext;
+          return serverResponseBodyWithoutSyncUrls;
+        });
+        return serverResponseWithoutSyncUrls;
+      });
+      expect(spec.getUserSyncs(syncOptions, serverResponsesWithoutSyncUrls)).to.be.an('array').that.is.empty;
+    });
+    it('should return empty array if all sync types are disabled', function () {
+      const syncOptions = {
+        iframeEnabled: false,
+        pixelEnabled: false
+      };
+      expect(spec.getUserSyncs(syncOptions, serverResponses)).to.be.an('array').that.is.empty;
+    });
+    it('should return iframe sync urls if iframe sync is enabled', function () {
+      const syncOptions = {
+        iframeEnabled: true,
+        pixelEnabled: false
+      };
+      expect(spec.getUserSyncs(syncOptions, serverResponses)).to.deep.equal([
+        {
+          type: 'iframe',
+          url: 'iframeUrl'
+        },
+        {
+          type: 'iframe',
+          url: 'iframeUrl2'
+        },
+        {
+          type: 'iframe',
+          url: 'iframeUrl3'
+        }
+      ]);
+    });
+    it('should return image sync urls if pixel sync is enabled', function () {
+      const syncOptions = {
+        iframeEnabled: false,
+        pixelEnabled: true
+      };
+      expect(spec.getUserSyncs(syncOptions, serverResponses)).to.deep.equal([
+        {
+          type: 'image',
+          url: 'pixelUrl'
+        },
+        {
+          type: 'image',
+          url: 'pixelUrl3'
+        },
+        {
+          type: 'image',
+          url: 'pixelUrl2'
+        }
+      ]);
+    });
+    it('should return all sync urls if all sync types are enabled', function () {
+      const syncOptions = {
+        iframeEnabled: true,
+        pixelEnabled: true
+      }
+      expect(spec.getUserSyncs(syncOptions, serverResponses)).to.deep.equal([
+        {
+          type: 'iframe',
+          url: 'iframeUrl'
+        },
+        {
+          type: 'iframe',
+          url: 'iframeUrl2'
+        },
+        {
+          type: 'iframe',
+          url: 'iframeUrl3'
+        },
+        {
+          type: 'image',
+          url: 'pixelUrl'
+        },
+        {
+          type: 'image',
+          url: 'pixelUrl3'
+        },
+        {
+          type: 'image',
+          url: 'pixelUrl2'
+        }
+      ]);
+    });
+  });
 });
 
 function validateAdUnit(adUnit, bid) {
@@ -323,5 +477,5 @@ function validateAdUnit(adUnit, bid) {
       width: size[0],
       height: size[1]
     }
-  }))
+  }));
 }

package/test/spec/modules/livewrappedAnalyticsAdapter_spec.js

@@ -2,6 +2,7 @@ import livewrappedAnalyticsAdapter, { BID_WON_TIMEOUT } from 'modules/livewrappe
 import CONSTANTS from 'src/constants.json';
 import { config } from 'src/config.js';
 import { server } from 'test/mocks/xhr.js';
+import { setConfig } from 'modules/currency.js';
 
 let events = require('src/events');
 let utils = require('src/utils');
@@ -16,7 +17,8 @@ const {
     BIDDER_DONE,
     BID_WON,
     BID_TIMEOUT,
-    SET_TARGETING
+    SET_TARGETING,
+    AD_RENDER_FAILED
   },
   STATUS: {
     GOOD
@@ -27,6 +29,9 @@ const BID1 = {
   width: 980,
   height: 240,
   cpm: 1.1,
+  originalCpm: 12.0,
+  currency: 'USD',
+  originalCurrency: 'FOO',
   timeToRespond: 200,
   bidId: '2ecff0db240757',
   requestId: '2ecff0db240757',
@@ -42,6 +47,9 @@ const BID2 = Object.assign({}, BID1, {
   width: 300,
   height: 250,
   cpm: 2.2,
+  originalCpm: 23.0,
+  currency: 'USD',
+  originalCurrency: 'FOO',
   timeToRespond: 300,
   bidId: '3ecff0db240757',
   requestId: '3ecff0db240757',
@@ -115,6 +123,14 @@ const MOCK = {
       'bidId': '2ecff0db240757',
       'auctionId': '25c6d7f5-699a-4bfc-87c9-996f915341fa'
     }
+  ],
+  AD_RENDER_FAILED: [
+    {
+      'bidId': '2ecff0db240757',
+      'reason': CONSTANTS.AD_RENDER_FAILED_REASON.CANNOT_FIND_AD,
+      'message': 'message',
+      'bid': BID1
+    }
   ]
 };
 
@@ -169,6 +185,7 @@ const ANALYTICS_MESSAGE = {
       width: 980,
       height: 240,
       cpm: 1.1,
+      orgCpm: 120,
       ttr: 200,
       IsBid: true,
       mediaType: 1,
@@ -183,6 +200,7 @@ const ANALYTICS_MESSAGE = {
       width: 300,
       height: 250,
       cpm: 2.2,
+      orgCpm: 230,
       ttr: 300,
       IsBid: true,
       mediaType: 1,
@@ -210,6 +228,7 @@ const ANALYTICS_MESSAGE = {
       width: 980,
       height: 240,
       cpm: 1.1,
+      orgCpm: 120,
       mediaType: 1,
       gdpr: 0,
       auctionId: 0
@@ -222,10 +241,22 @@ const ANALYTICS_MESSAGE = {
       width: 300,
       height: 250,
       cpm: 2.2,
+      orgCpm: 230,
       mediaType: 1,
       gdpr: 0,
       auctionId: 0
     }
+  ],
+  rf: [
+    {
+      timeStamp: 1519149562216,
+      adUnit: 'panorama_d_1',
+      adUnitId: 'adunitid',
+      bidder: 'livewrapped',
+      auctionId: 0,
+      rsn: CONSTANTS.AD_RENDER_FAILED_REASON.CANNOT_FIND_AD,
+      msg: 'message'
+    },
   ]
 };
 
@@ -239,6 +270,7 @@ function performStandardAuction() {
   events.emit(SET_TARGETING, MOCK.SET_TARGETING);
   events.emit(BID_WON, MOCK.BID_WON[0]);
   events.emit(BID_WON, MOCK.BID_WON[1]);
+  events.emit(AD_RENDER_FAILED, MOCK.AD_RENDER_FAILED[0]);
 }
 
 describe('Livewrapped analytics adapter', function () {
@@ -258,6 +290,14 @@ describe('Livewrapped analytics adapter', function () {
     sandbox.stub(document, 'getElementById').returns(element);
 
     clock = sandbox.useFakeTimers(1519767013781);
+    setConfig({
+      adServerCurrency: 'USD',
+      rates: {
+        USD: {
+          FOO: 0.1
+        }
+      }
+    });
   });
 
   afterEach(function () {
@@ -300,7 +340,7 @@ describe('Livewrapped analytics adapter', function () {
       expect(message).to.deep.equal(ANALYTICS_MESSAGE);
     });
 
-    it('should send batched message without BID_WON if necessary and further BID_WON events individually', function () {
+    it('should send batched message without BID_WON AND AD_RENDER_FAILED if necessary and further BID_WON and AD_RENDER_FAILED events individually', function () {
       events.emit(AUCTION_INIT, MOCK.AUCTION_INIT);
       events.emit(BID_REQUESTED, MOCK.BID_REQUESTED);
       events.emit(BID_RESPONSE, MOCK.BID_RESPONSE[0]);
@@ -313,8 +353,9 @@ describe('Livewrapped analytics adapter', function () {
       clock.tick(BID_WON_TIMEOUT + 1000);
 
       events.emit(BID_WON, MOCK.BID_WON[1]);
+      events.emit(AD_RENDER_FAILED, MOCK.AD_RENDER_FAILED[0]);
 
-      expect(server.requests.length).to.equal(2);
+      expect(server.requests.length).to.equal(3);
 
       let message = JSON.parse(server.requests[0].requestBody);
       expect(message.wins.length).to.equal(1);
@@ -324,6 +365,10 @@ describe('Livewrapped analytics adapter', function () {
       message = JSON.parse(server.requests[1].requestBody);
       expect(message.wins.length).to.equal(1);
       expect(message.wins[0]).to.deep.equal(ANALYTICS_MESSAGE.wins[1]);
+
+      message = JSON.parse(server.requests[2].requestBody);
+      expect(message.rf.length).to.equal(1);
+      expect(message.rf[0]).to.deep.equal(ANALYTICS_MESSAGE.rf[0]);
     });
 
     it('should properly mark bids as timed out', function () {
@@ -427,7 +472,7 @@ describe('Livewrapped analytics adapter', function () {
         {
           'floorData': {
             'floorValue': 1.1,
-            'floorCurrency': 'SEK'
+            'floorCurrency': 'FOO'
           }
         }));
       events.emit(BID_WON, Object.assign({},
@@ -435,7 +480,7 @@ describe('Livewrapped analytics adapter', function () {
         {
           'floorData': {
             'floorValue': 1.1,
-            'floorCurrency': 'SEK'
+            'floorCurrency': 'FOO'
           }
         }));
       events.emit(AUCTION_END, MOCK.AUCTION_END);
@@ -450,11 +495,11 @@ describe('Livewrapped analytics adapter', function () {
 
       expect(message.responses.length).to.equal(1);
       expect(message.responses[0].floor).to.equal(1.1);
-      expect(message.responses[0].floorCur).to.equal('SEK');
+      expect(message.responses[0].floorCur).to.equal('FOO');
 
       expect(message.wins.length).to.equal(1);
       expect(message.wins[0].floor).to.equal(1.1);
-      expect(message.wins[0].floorCur).to.equal('SEK');
+      expect(message.wins[0].floorCur).to.equal('FOO');
     });
 
     it('should forward Livewrapped floor data', function () {

package/test/spec/modules/merkleIdSystem_spec.js

@@ -192,6 +192,24 @@ describe('Merkle System', function () {
 
       expect(id.id).to.exist.and.to.equal(storedId);
     });
+    it('extendId() should warn on missing endpoint', function () {
+      let config = {
+        params: {
+          ...CONFIG_PARAMS,
+          endpoint: undefined
+        },
+        storage: STORAGE_PARAMS
+      };
+
+      let yesterday = new Date(Date.now() - 86400000).toUTCString();
+      let storedId = {value: 'Merkle_Stored_ID', date: yesterday};
+
+      let submoduleCallback = merkleIdSubmodule.extendId(config, undefined,
+        storedId).callback;
+      submoduleCallback(callbackSpy);
+      expect(callbackSpy.calledOnce).to.be.true;
+      expect(utils.logWarn.args[0][0]).to.exist.and.to.equal('User ID - merkleId submodule endpoint string is not defined');
+    });
 
     it('extendId() callback on configured storageParam.refreshInSeconds', function () {
       let config = {

package/test/spec/modules/multibid_spec.js

@@ -82,7 +82,7 @@ describe('multibid adapter', function () {
           'sizes': [[300, 250]]
         }
       },
-      'adUnitCode': 'test-div',
+      'adUnitCode': 'test.div',
       'transactionId': 'c153f3da-84f0-4be8-95cb-0647c458bc60',
       'sizes': [[300, 250]],
       'bidId': '2408ef83b84c9d',
@@ -106,7 +106,7 @@ describe('multibid adapter', function () {
           'sizes': [[300, 250]]
         }
       },
-      'adUnitCode': 'test-div',
+      'adUnitCode': 'test.div',
       'transactionId': 'c153f3da-84f0-4be8-95cb-0647c458bc60',
       'sizes': [[300, 250]],
       'bidId': '2408ef83b84c9d',
@@ -197,14 +197,14 @@ describe('multibid adapter', function () {
     });
 
     it('adds original bids and does not modify', function () {
-      let adUnitCode = 'test-div';
+      let adUnitCode = 'test.div';
       let bids = [{...bidArray[0]}, {...bidArray[1]}];
 
       addBidResponseHook(callbackFn, adUnitCode, {...bids[0]});
 
       expect(result).to.not.equal(null);
       expect(result.adUnitCode).to.not.equal(null);
-      expect(result.adUnitCode).to.equal('test-div');
+      expect(result.adUnitCode).to.equal('test.div');
       expect(result.bid).to.not.equal(null);
       expect(result.bid).to.deep.equal(bids[0]);
 
@@ -214,13 +214,13 @@ describe('multibid adapter', function () {
 
       expect(result).to.not.equal(null);
       expect(result.adUnitCode).to.not.equal(null);
-      expect(result.adUnitCode).to.equal('test-div');
+      expect(result.adUnitCode).to.equal('test.div');
       expect(result.bid).to.not.equal(null);
       expect(result.bid).to.deep.equal(bids[1]);
     });
 
     it('modifies and adds both bids based on multibid configuration', function () {
-      let adUnitCode = 'test-div';
+      let adUnitCode = 'test.div';
       let bids = [{...bidArray[0]}, {...bidArray[1]}];
 
       config.setConfig({multibid: [{bidder: 'bidderA', maxBids: 2, targetBiddercodePrefix: 'bidA'}]});
@@ -232,7 +232,7 @@ describe('multibid adapter', function () {
 
       expect(result).to.not.equal(null);
       expect(result.adUnitCode).to.not.equal(null);
-      expect(result.adUnitCode).to.equal('test-div');
+      expect(result.adUnitCode).to.equal('test.div');
       expect(result.bid).to.not.equal(null);
       expect(result.bid).to.deep.equal(bids[0]);
 
@@ -250,13 +250,13 @@ describe('multibid adapter', function () {
 
       expect(result).to.not.equal(null);
       expect(result.adUnitCode).to.not.equal(null);
-      expect(result.adUnitCode).to.equal('test-div');
+      expect(result.adUnitCode).to.equal('test.div');
       expect(result.bid).to.not.equal(null);
       expect(result.bid).to.deep.equal(bids[1]);
     });
 
     it('only modifies bids defined in the multibid configuration', function () {
-      let adUnitCode = 'test-div';
+      let adUnitCode = 'test.div';
       let bids = [{...bidArray[0]}, {...bidArray[1]}];
 
       bids.push({
@@ -276,7 +276,7 @@ describe('multibid adapter', function () {
 
       expect(result).to.not.equal(null);
       expect(result.adUnitCode).to.not.equal(null);
-      expect(result.adUnitCode).to.equal('test-div');
+      expect(result.adUnitCode).to.equal('test.div');
       expect(result.bid).to.not.equal(null);
       expect(result.bid).to.deep.equal(bids[0]);
 
@@ -292,7 +292,7 @@ describe('multibid adapter', function () {
 
       expect(result).to.not.equal(null);
       expect(result.adUnitCode).to.not.equal(null);
-      expect(result.adUnitCode).to.equal('test-div');
+      expect(result.adUnitCode).to.equal('test.div');
       expect(result.bid).to.not.equal(null);
       expect(result.bid).to.deep.equal(bids[1]);
 
@@ -302,13 +302,13 @@ describe('multibid adapter', function () {
 
       expect(result).to.not.equal(null);
       expect(result.adUnitCode).to.not.equal(null);
-      expect(result.adUnitCode).to.equal('test-div');
+      expect(result.adUnitCode).to.equal('test.div');
       expect(result.bid).to.not.equal(null);
       expect(result.bid).to.deep.equal(bids[2]);
     });
 
     it('only modifies and returns bids under limit for a specifc bidder in the multibid configuration', function () {
-      let adUnitCode = 'test-div';
+      let adUnitCode = 'test.div';
       let bids = [{...bidArray[0]}, {...bidArray[1]}];
 
       bids.push({
@@ -328,7 +328,7 @@ describe('multibid adapter', function () {
 
       expect(result).to.not.equal(null);
       expect(result.adUnitCode).to.not.equal(null);
-      expect(result.adUnitCode).to.equal('test-div');
+      expect(result.adUnitCode).to.equal('test.div');
       expect(result.bid).to.not.equal(null);
       expect(result.bid).to.deep.equal(bids[0]);
 
@@ -344,7 +344,7 @@ describe('multibid adapter', function () {
 
       expect(result).to.not.equal(null);
       expect(result.adUnitCode).to.not.equal(null);
-      expect(result.adUnitCode).to.equal('test-div');
+      expect(result.adUnitCode).to.equal('test.div');
       expect(result.bid).to.not.equal(null);
       expect(result.bid).to.deep.equal(bids[1]);
 
@@ -356,7 +356,7 @@ describe('multibid adapter', function () {
     });
 
     it('if no prefix in multibid configuration, modifies and returns bids under limit without preifx property', function () {
-      let adUnitCode = 'test-div';
+      let adUnitCode = 'test.div';
       let bids = [{...bidArray[0]}, {...bidArray[1]}];
 
       bids.push({
@@ -375,7 +375,7 @@ describe('multibid adapter', function () {
 
       expect(result).to.not.equal(null);
       expect(result.adUnitCode).to.not.equal(null);
-      expect(result.adUnitCode).to.equal('test-div');
+      expect(result.adUnitCode).to.equal('test.div');
       expect(result.bid).to.not.equal(null);
       expect(result.bid).to.deep.equal(bids[0]);
 
@@ -389,7 +389,7 @@ describe('multibid adapter', function () {
 
       expect(result).to.not.equal(null);
       expect(result.adUnitCode).to.not.equal(null);
-      expect(result.adUnitCode).to.equal('test-div');
+      expect(result.adUnitCode).to.equal('test.div');
       expect(result.bid).to.not.equal(null);
       expect(result.bid).to.deep.equal(bids[1]);
 
@@ -401,7 +401,7 @@ describe('multibid adapter', function () {
     });
 
     it('does not include extra bids if cpm is less than floor value', function () {
-      let adUnitCode = 'test-div';
+      let adUnitCode = 'test.div';
       let bids = [{...bidArrayAlt[1]}, {...bidArrayAlt[0]}, {...bidArrayAlt[2]}, {...bidArrayAlt[3]}];
 
       bids.map(bid => {
@@ -418,7 +418,7 @@ describe('multibid adapter', function () {
           floorRuleValue: 65,
           floorValue: 65,
           matchedFields: {
-            gptSlot: 'test-div',
+            gptSlot: 'test.div',
             mediaType: 'banner'
           }
         }
@@ -435,7 +435,7 @@ describe('multibid adapter', function () {
 
       expect(result).to.not.equal(null);
       expect(result.adUnitCode).to.not.equal(null);
-      expect(result.adUnitCode).to.equal('test-div');
+      expect(result.adUnitCode).to.equal('test.div');
       expect(result.bid).to.not.equal(null);
       expect(result.bid.bidder).to.equal('bidderA');
       expect(result.bid.targetingBidder).to.equal(undefined);
@@ -452,7 +452,7 @@ describe('multibid adapter', function () {
 
       expect(result).to.not.equal(null);
       expect(result.adUnitCode).to.not.equal(null);
-      expect(result.adUnitCode).to.equal('test-div');
+      expect(result.adUnitCode).to.equal('test.div');
       expect(result.bid).to.not.equal(null);
       expect(result.bid.bidder).to.equal('bidderB');
       expect(result.bid.targetingBidder).to.equal(undefined);
@@ -463,14 +463,14 @@ describe('multibid adapter', function () {
 
       expect(result).to.not.equal(null);
       expect(result.adUnitCode).to.not.equal(null);
-      expect(result.adUnitCode).to.equal('test-div');
+      expect(result.adUnitCode).to.equal('test.div');
       expect(result.bid).to.not.equal(null);
       expect(result.bid.bidder).to.equal('bidderC');
       expect(result.bid.targetingBidder).to.equal(undefined);
     });
 
     it('does  include extra bids if cpm is not less than floor value', function () {
-      let adUnitCode = 'test-div';
+      let adUnitCode = 'test.div';
       let bids = [{...bidArrayAlt[1]}, {...bidArrayAlt[0]}];
 
       bids.map(bid => {
@@ -487,7 +487,7 @@ describe('multibid adapter', function () {
           floorRuleValue: 25,
           floorValue: 25,
           matchedFields: {
-            gptSlot: 'test-div',
+            gptSlot: 'test.div',
             mediaType: 'banner'
           }
         }
@@ -504,7 +504,7 @@ describe('multibid adapter', function () {
 
       expect(result).to.not.equal(null);
       expect(result.adUnitCode).to.not.equal(null);
-      expect(result.adUnitCode).to.equal('test-div');
+      expect(result.adUnitCode).to.equal('test.div');
       expect(result.bid).to.not.equal(null);
       expect(result.bid.bidder).to.equal('bidderA');
       expect(result.bid.targetingBidder).to.equal(undefined);
@@ -518,7 +518,7 @@ describe('multibid adapter', function () {
 
       expect(result).to.not.equal(null);
       expect(result.adUnitCode).to.not.equal(null);
-      expect(result.adUnitCode).to.equal('test-div');
+      expect(result.adUnitCode).to.equal('test.div');
       expect(result.bid).to.not.equal(null);
       expect(result.bid.bidder).to.equal('bidderA');
       expect(result.bid.targetingBidder).to.equal('bidA2');
@@ -578,7 +578,7 @@ describe('multibid adapter', function () {
 
     it('it sorts and creates dynamic alias on bidsReceived if multibid configuration found with prefix', function () {
       let modifiedBids = [{...bidArray[1]}, {...bidArray[0]}].map(bid => {
-        addBidResponseHook(bidResponseCallback, 'test-div', {...bid});
+        addBidResponseHook(bidResponseCallback, 'test.div', {...bid});
 
         return bidResult;
       });
@@ -603,7 +603,7 @@ describe('multibid adapter', function () {
 
     it('it sorts by cpm treating dynamic alias as unique bid when no bid limit defined', function () {
       let modifiedBids = [{...bidArrayAlt[0]}, {...bidArrayAlt[2]}, {...bidArrayAlt[3]}, {...bidArrayAlt[1]}].map(bid => {
-        addBidResponseHook(bidResponseCallback, 'test-div', {...bid});
+        addBidResponseHook(bidResponseCallback, 'test.div', {...bid});
 
         return bidResult;
       });
@@ -636,7 +636,7 @@ describe('multibid adapter', function () {
 
     it('it should filter out dynamic bid when bid limit is less than unique bid pool', function () {
       let modifiedBids = [{...bidArrayAlt[0]}, {...bidArrayAlt[2]}, {...bidArrayAlt[3]}, {...bidArrayAlt[1]}].map(bid => {
-        addBidResponseHook(bidResponseCallback, 'test-div', {...bid});
+        addBidResponseHook(bidResponseCallback, 'test.div', {...bid});
 
         return bidResult;
       });
@@ -662,7 +662,7 @@ describe('multibid adapter', function () {
       config.setConfig({ multibid: [{bidder: 'bidderA', maxBids: 2, targetBiddercodePrefix: 'bidA'}] });
 
       let modifiedBids = [{...bidArrayAlt[0]}, {...bidArrayAlt[2]}, {...bidArrayAlt[3]}, {...bidArrayAlt[1]}].map(bid => {
-        addBidResponseHook(bidResponseCallback, 'test-div', {...bid});
+        addBidResponseHook(bidResponseCallback, 'test.div', {...bid});
 
         return bidResult;
       });