prebid.js 6.4.0 → 6.8.0

package/test/spec/modules/zeta_global_sspAnalyticsAdapter_spec.js

@@ -0,0 +1,427 @@
+import zetaAnalyticsAdapter from 'modules/zeta_global_sspAnalyticsAdapter.js';
+import {config} from 'src/config';
+import CONSTANTS from 'src/constants.json';
+import {logError} from '../../../src/utils';
+
+let utils = require('src/utils');
+let events = require('src/events');
+
+const MOCK = {
+  STUB: {
+    'auctionId': '25c6d7f5-699a-4bfc-87c9-996f915341fa'
+  },
+  AUCTION_END: {
+    'auctionId': '75e394d9-ccce-4978-9238-91e6a1ac88a1',
+    'timestamp': 1638441234544,
+    'auctionEnd': 1638441234784,
+    'auctionStatus': 'completed',
+    'adUnits': [
+      {
+        'code': '/19968336/header-bid-tag-0',
+        'mediaTypes': {
+          'banner': {
+            'sizes': [
+              [
+                300,
+                250
+              ],
+              [
+                300,
+                600
+              ]
+            ]
+          }
+        },
+        'bids': [
+          {
+            'bidder': 'zeta_global_ssp',
+            'params': {
+              'sid': 111,
+              'tags': {
+                'shortname': 'prebid_analytics_event_test_shortname',
+                'position': 'test_position'
+              }
+            }
+          },
+          {
+            'bidder': 'appnexus',
+            'params': {
+              'placementId': 13232385
+            }
+          }
+        ],
+        'sizes': [
+          [
+            300,
+            250
+          ],
+          [
+            300,
+            600
+          ]
+        ],
+        'transactionId': '6b29369c-0c2e-414e-be1f-5867aec18d83'
+      }
+    ],
+    'adUnitCodes': [
+      '/19968336/header-bid-tag-0'
+    ],
+    'bidderRequests': [
+      {
+        'bidderCode': 'zeta_global_ssp',
+        'auctionId': '75e394d9-ccce-4978-9238-91e6a1ac88a1',
+        'bidderRequestId': '1207cb49191887',
+        'bids': [
+          {
+            'bidder': 'zeta_global_ssp',
+            'params': {
+              'sid': 111,
+              'tags': {
+                'shortname': 'prebid_analytics_event_test_shortname',
+                'position': 'test_position'
+              }
+            },
+            'mediaTypes': {
+              'banner': {
+                'sizes': [
+                  [
+                    300,
+                    250
+                  ],
+                  [
+                    300,
+                    600
+                  ]
+                ]
+              }
+            },
+            'adUnitCode': '/19968336/header-bid-tag-0',
+            'transactionId': '6b29369c-0c2e-414e-be1f-5867aec18d83',
+            'sizes': [
+              [
+                300,
+                250
+              ],
+              [
+                300,
+                600
+              ]
+            ],
+            'bidId': '206be9a13236af',
+            'bidderRequestId': '1207cb49191887',
+            'auctionId': '75e394d9-ccce-4978-9238-91e6a1ac88a1',
+            'src': 'client',
+            'bidRequestsCount': 1,
+            'bidderRequestsCount': 1,
+            'bidderWinsCount': 0
+          }
+        ],
+        'auctionStart': 1638441234544,
+        'timeout': 400,
+        'refererInfo': {
+          'referer': 'http://test-zeta-ssp.net:63342/zeta-ssp/ssp/_dev/examples/page_banner.html',
+          'reachedTop': true,
+          'isAmp': false,
+          'numIframes': 0,
+          'stack': [
+            'http://test-zeta-ssp.net:63342/zeta-ssp/ssp/_dev/examples/page_banner.html'
+          ],
+          'canonicalUrl': null
+        },
+        'start': 1638441234547
+      },
+      {
+        'bidderCode': 'appnexus',
+        'auctionId': '75e394d9-ccce-4978-9238-91e6a1ac88a1',
+        'bidderRequestId': '32b97f0a935422',
+        'bids': [
+          {
+            'bidder': 'appnexus',
+            'params': {
+              'placementId': 13232385
+            },
+            'mediaTypes': {
+              'banner': {
+                'sizes': [
+                  [
+                    300,
+                    250
+                  ],
+                  [
+                    300,
+                    600
+                  ]
+                ]
+              }
+            },
+            'adUnitCode': '/19968336/header-bid-tag-0',
+            'transactionId': '6b29369c-0c2e-414e-be1f-5867aec18d83',
+            'sizes': [
+              [
+                300,
+                250
+              ],
+              [
+                300,
+                600
+              ]
+            ],
+            'bidId': '41badc0e164c758',
+            'bidderRequestId': '32b97f0a935422',
+            'auctionId': '75e394d9-ccce-4978-9238-91e6a1ac88a1',
+            'src': 'client',
+            'bidRequestsCount': 1,
+            'bidderRequestsCount': 1,
+            'bidderWinsCount': 0
+          }
+        ],
+        'auctionStart': 1638441234544,
+        'timeout': 400,
+        'refererInfo': {
+          'referer': 'http://test-zeta-ssp.net:63342/zeta-ssp/ssp/_dev/examples/page_banner.html',
+          'reachedTop': true,
+          'isAmp': false,
+          'numIframes': 0,
+          'stack': [
+            'http://test-zeta-ssp.net:63342/zeta-ssp/ssp/_dev/examples/page_banner.html'
+          ],
+          'canonicalUrl': null
+        },
+        'start': 1638441234550
+      }
+    ],
+    'noBids': [
+      {
+        'bidder': 'appnexus',
+        'params': {
+          'placementId': 13232385
+        },
+        'mediaTypes': {
+          'banner': {
+            'sizes': [
+              [
+                300,
+                250
+              ],
+              [
+                300,
+                600
+              ]
+            ]
+          }
+        },
+        'adUnitCode': '/19968336/header-bid-tag-0',
+        'transactionId': '6b29369c-0c2e-414e-be1f-5867aec18d83',
+        'sizes': [
+          [
+            300,
+            250
+          ],
+          [
+            300,
+            600
+          ]
+        ],
+        'bidId': '41badc0e164c758',
+        'bidderRequestId': '32b97f0a935422',
+        'auctionId': '75e394d9-ccce-4978-9238-91e6a1ac88a1',
+        'src': 'client',
+        'bidRequestsCount': 1,
+        'bidderRequestsCount': 1,
+        'bidderWinsCount': 0
+      }
+    ],
+    'bidsReceived': [
+      {
+        'bidderCode': 'zeta_global_ssp',
+        'width': 480,
+        'height': 320,
+        'statusMessage': 'Bid available',
+        'adId': '5759bb3ef7be1e8',
+        'requestId': '206be9a13236af',
+        'mediaType': 'banner',
+        'source': 'client',
+        'cpm': 2.258302852806723,
+        'currency': 'USD',
+        'ad': 'test_ad',
+        'ttl': 200,
+        'creativeId': '456456456',
+        'netRevenue': true,
+        'meta': {
+          'advertiserDomains': [
+            'viaplay.fi'
+          ]
+        },
+        'originalCpm': 2.258302852806723,
+        'originalCurrency': 'USD',
+        'auctionId': '75e394d9-ccce-4978-9238-91e6a1ac88a1',
+        'responseTimestamp': 1638441234670,
+        'requestTimestamp': 1638441234547,
+        'bidder': 'zeta_global_ssp',
+        'adUnitCode': '/19968336/header-bid-tag-0',
+        'timeToRespond': 123,
+        'pbLg': '2.00',
+        'pbMg': '2.20',
+        'pbHg': '2.25',
+        'pbAg': '2.25',
+        'pbDg': '2.25',
+        'pbCg': '',
+        'size': '480x320',
+        'adserverTargeting': {
+          'hb_bidder': 'zeta_global_ssp',
+          'hb_adid': '5759bb3ef7be1e8',
+          'hb_pb': '2.20',
+          'hb_size': '480x320',
+          'hb_source': 'client',
+          'hb_format': 'banner',
+          'hb_adomain': 'viaplay.fi'
+        }
+      }
+    ],
+    'winningBids': [],
+    'timeout': 400
+  },
+  AD_RENDER_SUCCEEDED: {
+    'doc': {
+      'location': {
+        'href': 'http://test-zeta-ssp.net:63342/zeta-ssp/ssp/_dev/examples/page_banner.html',
+        'protocol': 'http:',
+        'host': 'localhost:63342',
+        'hostname': 'localhost',
+        'port': '63342',
+        'pathname': '/zeta-ssp/ssp/_dev/examples/page_banner.html',
+        'hash': '',
+        'origin': 'http://test-zeta-ssp.net:63342',
+        'ancestorOrigins': {
+          '0': 'http://test-zeta-ssp.net:63342'
+        }
+      }
+    },
+    'bid': {
+      'bidderCode': 'zeta_global_ssp',
+      'width': 480,
+      'height': 320,
+      'statusMessage': 'Bid available',
+      'adId': '5759bb3ef7be1e8',
+      'requestId': '206be9a13236af',
+      'mediaType': 'banner',
+      'source': 'client',
+      'cpm': 2.258302852806723,
+      'currency': 'USD',
+      'ad': 'test_ad',
+      'ttl': 200,
+      'creativeId': '456456456',
+      'netRevenue': true,
+      'meta': {
+        'advertiserDomains': [
+          'viaplay.fi'
+        ]
+      },
+      'originalCpm': 2.258302852806723,
+      'originalCurrency': 'USD',
+      'auctionId': '75e394d9-ccce-4978-9238-91e6a1ac88a1',
+      'responseTimestamp': 1638441234670,
+      'requestTimestamp': 1638441234547,
+      'bidder': 'zeta_global_ssp',
+      'adUnitCode': '/19968336/header-bid-tag-0',
+      'timeToRespond': 123,
+      'pbLg': '2.00',
+      'pbMg': '2.20',
+      'pbHg': '2.25',
+      'pbAg': '2.25',
+      'pbDg': '2.25',
+      'pbCg': '',
+      'size': '480x320',
+      'adserverTargeting': {
+        'hb_bidder': 'zeta_global_ssp',
+        'hb_adid': '5759bb3ef7be1e8',
+        'hb_pb': '2.20',
+        'hb_size': '480x320',
+        'hb_source': 'client',
+        'hb_format': 'banner',
+        'hb_adomain': 'viaplay.fi'
+      },
+      'status': 'rendered',
+      'params': [
+        {
+          'sid': 111,
+          'tags': {
+            'shortname': 'prebid_analytics_event_test_shortname',
+            'position': 'test_position'
+          }
+        }
+      ]
+    },
+    'adId': '5759bb3ef7be1e8'
+  }
+}
+
+describe('Zeta Global SSP Analytics Adapter', function() {
+  let sandbox;
+  let xhr;
+  let requests;
+
+  beforeEach(function() {
+    sandbox = sinon.sandbox.create();
+    requests = [];
+    xhr = sandbox.useFakeXMLHttpRequest();
+    xhr.onCreate = request => requests.push(request);
+    sandbox.stub(events, 'getEvents').returns([]);
+  });
+
+  afterEach(function () {
+    sandbox.restore();
+    config.resetConfig();
+  });
+
+  it('should require publisherId', function () {
+    sandbox.stub(utils, 'logError');
+    zetaAnalyticsAdapter.enableAnalytics({
+      options: {}
+    });
+    expect(utils.logError.called).to.equal(true);
+  });
+
+  describe('handle events', function() {
+    beforeEach(function() {
+      zetaAnalyticsAdapter.enableAnalytics({
+        options: {
+          sid: 111
+        }
+      });
+    });
+
+    afterEach(function () {
+      zetaAnalyticsAdapter.disableAnalytics();
+    });
+
+    it('events are sent', function() {
+      this.timeout(5000);
+      events.emit(CONSTANTS.EVENTS.AUCTION_INIT, MOCK.STUB);
+      events.emit(CONSTANTS.EVENTS.AUCTION_END, MOCK.AUCTION_END);
+      events.emit(CONSTANTS.EVENTS.BID_ADJUSTMENT, MOCK.STUB);
+      events.emit(CONSTANTS.EVENTS.BID_TIMEOUT, MOCK.STUB);
+      events.emit(CONSTANTS.EVENTS.BID_REQUESTED, MOCK.STUB);
+      events.emit(CONSTANTS.EVENTS.BID_RESPONSE, MOCK.STUB);
+      events.emit(CONSTANTS.EVENTS.NO_BID, MOCK.STUB);
+      events.emit(CONSTANTS.EVENTS.BID_WON, MOCK.STUB);
+      events.emit(CONSTANTS.EVENTS.BIDDER_DONE, MOCK.STUB);
+      events.emit(CONSTANTS.EVENTS.BIDDER_ERROR, MOCK.STUB);
+      events.emit(CONSTANTS.EVENTS.SET_TARGETING, MOCK.STUB);
+      events.emit(CONSTANTS.EVENTS.BEFORE_REQUEST_BIDS, MOCK.STUB);
+      events.emit(CONSTANTS.EVENTS.BEFORE_BIDDER_HTTP, MOCK.STUB);
+      events.emit(CONSTANTS.EVENTS.REQUEST_BIDS, MOCK.STUB);
+      events.emit(CONSTANTS.EVENTS.ADD_AD_UNITS, MOCK.STUB);
+      events.emit(CONSTANTS.EVENTS.AD_RENDER_FAILED, MOCK.STUB);
+      events.emit(CONSTANTS.EVENTS.AD_RENDER_SUCCEEDED, MOCK.AD_RENDER_SUCCEEDED);
+      events.emit(CONSTANTS.EVENTS.TCF2_ENFORCEMENT, MOCK.STUB);
+      events.emit(CONSTANTS.EVENTS.AUCTION_DEBUG, MOCK.STUB);
+      events.emit(CONSTANTS.EVENTS.BID_VIEWABLE, MOCK.STUB);
+      events.emit(CONSTANTS.EVENTS.STALE_RENDER, MOCK.STUB);
+
+      expect(requests.length).to.equal(2);
+      expect(JSON.parse(requests[0].requestBody)).to.deep.equal(MOCK.AUCTION_END);
+      expect(JSON.parse(requests[1].requestBody)).to.deep.equal(MOCK.AD_RENDER_SUCCEEDED);
+    });
+  });
+});

package/test/spec/unit/pbjs_api_spec.js

@@ -16,6 +16,7 @@ import * as auctionModule from 'src/auction.js';
 import { registerBidder } from 'src/adapters/bidderFactory.js';
 import { _sendAdToCreative } from 'src/secureCreatives.js';
 import find from 'core-js-pure/features/array/find.js';
+import {synchronizePromise} from '../../helpers/syncPromise.js';
 
 var assert = require('chai').assert;
 var expect = require('chai').expect;
@@ -190,13 +191,16 @@ window.apntag = {
 }
 
 describe('Unit: Prebid Module', function () {
-  let bidExpiryStub;
+  let bidExpiryStub, promiseSandbox;
   beforeEach(function () {
+    promiseSandbox = sinon.createSandbox();
+    synchronizePromise(promiseSandbox);
     bidExpiryStub = sinon.stub(filters, 'isBidNotExpired').callsFake(() => true);
     configObj.setConfig({ useBidCache: true });
   });
 
   afterEach(function() {
+    promiseSandbox.restore();
     $$PREBID_GLOBAL$$.adUnits = [];
     bidExpiryStub.restore();
     configObj.setConfig({ useBidCache: false });
@@ -1135,13 +1139,15 @@ describe('Unit: Prebid Module', function () {
             height: 0
           }
         },
-        getElementsByTagName: sinon.stub()
+        getElementsByTagName: sinon.stub(),
+        querySelector: sinon.stub()
       };
 
       elStub = {
         insertBefore: sinon.stub()
       };
       doc.getElementsByTagName.returns([elStub]);
+      doc.querySelector.returns(elStub);
 
       spyLogError = sinon.spy(utils, 'logError');
       spyLogMessage = sinon.spy(utils, 'logMessage');
@@ -1852,11 +1858,23 @@ describe('Unit: Prebid Module', function () {
                   pos: 2
                 }
               }
+            },
+            {
+              code: 'test6',
+              bids: [],
+              sizes: [300, 250],
+              mediaTypes: {
+                banner: {
+                  sizes: [300, 250],
+                  pos: 0
+                }
+              }
             }];
             $$PREBID_GLOBAL$$.requestBids({
               adUnits: adUnit
             });
             expect(auctionArgs.adUnits[0].mediaTypes.banner.pos).to.equal(2);
+            expect(auctionArgs.adUnits[1].mediaTypes.banner.pos).to.equal(0);
           });
         });
 

package/test/spec/unit/secureCreatives_spec.js

@@ -1,6 +1,7 @@
 import {
   _sendAdToCreative, receiveMessage
 } from 'src/secureCreatives.js';
+import * as secureCreatives from 'src/secureCreatives.js';
 import * as utils from 'src/utils.js';
 import {getAdUnits, getBidRequests, getBidResponses} from 'test/fixtures/fixtures.js';
 import {auctionManager} from 'src/auctionManager.js';
@@ -9,6 +10,7 @@ import * as native from 'src/native.js';
 import {fireNativeTrackers, getAllAssetsMessage} from 'src/native.js';
 import events from 'src/events.js';
 import { config as configObj } from 'src/config.js';
+import 'src/prebid.js';
 
 import { expect } from 'chai';
 
@@ -237,6 +239,38 @@ describe('secureCreatives', () => {
 
         configObj.setConfig({'auctionOptions': {}});
       });
+
+      it('should emit AD_RENDER_FAILED if requested missing adId', () => {
+        const ev = {
+          data: JSON.stringify({
+            message: 'Prebid Request',
+            adId: 'missing'
+          })
+        };
+        receiveMessage(ev);
+        sinon.assert.calledWith(stubEmit, CONSTANTS.EVENTS.AD_RENDER_FAILED, sinon.match({
+          reason: CONSTANTS.AD_RENDER_FAILED_REASON.CANNOT_FIND_AD,
+          adId: 'missing'
+        }));
+      });
+
+      it('should emit AD_RENDER_FAILED if creative can\'t be sent to rendering frame', () => {
+        pushBidResponseToAuction({});
+        const ev = {
+          source: {
+            postMessage: sinon.stub().callsFake(() => { throw new Error(); })
+          },
+          data: JSON.stringify({
+            message: 'Prebid Request',
+            adId: bidId
+          })
+        }
+        receiveMessage(ev)
+        sinon.assert.calledWith(stubEmit, CONSTANTS.EVENTS.AD_RENDER_FAILED, sinon.match({
+          reason: CONSTANTS.AD_RENDER_FAILED_REASON.EXCEPTION,
+          adId: bidId
+        }));
+      });
     });
 
     describe('Prebid Native', function() {
@@ -395,5 +429,56 @@ describe('secureCreatives', () => {
         expect(adResponse).to.have.property('status', CONSTANTS.BID_STATUS.RENDERED);
       });
     });
+
+    describe('Prebid Event', () => {
+      Object.entries({
+        'unrendered': [false, (bid) => { delete bid.status; }],
+        'rendered': [true, (bid) => { bid.status = CONSTANTS.BID_STATUS.RENDERED }]
+      }).forEach(([test, [shouldEmit, prepBid]]) => {
+        describe(`for ${test} bids`, () => {
+          beforeEach(() => {
+            prepBid(adResponse);
+            pushBidResponseToAuction(adResponse);
+          });
+
+          it(`should${shouldEmit ? ' ' : ' not '}emit AD_RENDER_FAILED`, () => {
+            const event = {
+              data: JSON.stringify({
+                message: 'Prebid Event',
+                event: CONSTANTS.EVENTS.AD_RENDER_FAILED,
+                adId: bidId,
+                info: {
+                  reason: 'Fail reason',
+                  message: 'Fail message',
+                },
+              })
+            };
+            receiveMessage(event);
+            expect(stubEmit.calledWith(CONSTANTS.EVENTS.AD_RENDER_FAILED, {
+              adId: bidId,
+              bid: adResponse,
+              reason: 'Fail reason',
+              message: 'Fail message'
+            })).to.equal(shouldEmit);
+          });
+
+          it(`should${shouldEmit ? ' ' : ' not '}emit AD_RENDER_SUCCEEDED`, () => {
+            const event = {
+              data: JSON.stringify({
+                message: 'Prebid Event',
+                event: CONSTANTS.EVENTS.AD_RENDER_SUCCEEDED,
+                adId: bidId,
+              })
+            };
+            receiveMessage(event);
+            expect(stubEmit.calledWith(CONSTANTS.EVENTS.AD_RENDER_SUCCEEDED, {
+              adId: bidId,
+              bid: adResponse,
+              doc: null
+            })).to.equal(shouldEmit);
+          });
+        });
+      });
+    });
   });
 });