improves additional data passed to the handler in AuctionInit and Auc…

…tionEnd events (prebid#3168)
devunrulymedia · Jan 30, 2019 · 4faa3ec · 4faa3ec
1 parent b0e3595
commit 4faa3ec
Show file tree

Hide file tree

Showing 2 changed files with 24 additions and 10 deletions.
diff --git a/src/auction.js b/src/auction.js
@@ -96,6 +96,7 @@ export function newAuction({adUnits, adUnitCodes, callback, cbTimeout, labels})
   let _bidderRequests = [];
   let _bidsReceived = [];
   let _auctionStart;
+  let _auctionEnd;
   let _auctionId = utils.generateUUID();
   let _auctionStatus;
   let _callback = callback;
@@ -106,6 +107,22 @@ export function newAuction({adUnits, adUnitCodes, callback, cbTimeout, labels})
   function addBidRequests(bidderRequests) { _bidderRequests = _bidderRequests.concat(bidderRequests) };
   function addBidReceived(bidsReceived) { _bidsReceived = _bidsReceived.concat(bidsReceived); }
 
+  function getProperties() {
+    return {
+      auctionId: _auctionId,
+      auctionStart: _auctionStart,
+      auctionEnd: _auctionEnd,
+      auctionStatus: _auctionStatus,
+      adUnits: _adUnits,
+      adUnitCodes: _adUnitCodes,
+      labels: _labels,
+      bidderRequests: _bidderRequests,
+      bidsReceived: _bidsReceived,
+      winningBids: _winningBids,
+      timeout: _timeout
+    };
+  }
+
   function startAuctionTimer() {
     const timedOut = true;
     const timeoutCallback = executeCallback.bind(null, timedOut);
@@ -129,10 +146,12 @@ export function newAuction({adUnits, adUnitCodes, callback, cbTimeout, labels})
         }
       }
 
-      events.emit(CONSTANTS.EVENTS.AUCTION_END, {auctionId: _auctionId});
-
       try {
         _auctionStatus = AUCTION_COMPLETED;
+        _auctionEnd = Date.now();
+
+        events.emit(CONSTANTS.EVENTS.AUCTION_END, getProperties());
+
         const adUnitCodes = _adUnitCodes;
         const bids = _bidsReceived
           .filter(adUnitsFilter.bind(this, adUnitCodes))
@@ -185,12 +204,7 @@ export function newAuction({adUnits, adUnitCodes, callback, cbTimeout, labels})
 
           _auctionStatus = AUCTION_IN_PROGRESS;
 
-          const auctionInit = {
-            timestamp: _auctionStart,
-            auctionId: _auctionId,
-            timeout: _timeout
-          };
-          events.emit(CONSTANTS.EVENTS.AUCTION_INIT, auctionInit);
+          events.emit(CONSTANTS.EVENTS.AUCTION_INIT, getProperties());
 
           let callbacks = auctionCallbacks(auctionDone, this);
           let boundObj = {

diff --git a/test/spec/unit/pbjs_api_spec.js b/test/spec/unit/pbjs_api_spec.js
@@ -1591,8 +1591,8 @@ describe('Unit: Prebid Module', function () {
   describe('emit', function () {
     it('should be able to emit event without arguments', function () {
       var spyEventsEmit = sinon.spy(events, 'emit');
-      events.emit(CONSTANTS.EVENTS.AUCTION_END);
-      assert.ok(spyEventsEmit.calledWith('auctionEnd'));
+      events.emit(CONSTANTS.EVENTS.REQUEST_BIDS);
+      assert.ok(spyEventsEmit.calledWith('requestBids'));
       events.emit.restore();
     });
   });