Merged in pcman@code_cleanup (pull request prebid#24)

Pcman@code cleanup

Approved-by: Yuan-Hung Huang <[email protected]>

Author: PCMan-Appier

modules/appierAnalyticsAdapter.js

@@ -94,7 +94,7 @@ export const appierAnalyticsAdapter = Object.assign(adapter({DEFAULT_SERVER, ana
       contentType: 'application/json'
     });
   },
-  newCommonMessageBody(auctionId) {
+  createCommonMessage(auctionId) {
     return {
       version: ANALYTICS_VERSION,
       auctionId: auctionId,
@@ -126,9 +126,16 @@ export const appierAnalyticsAdapter = Object.assign(adapter({DEFAULT_SERVER, ana
     }
     return result;
   },
-  newAuctionMessageBody(auctionEndArgs, winningBids, timeoutBids) {
+  addBidResponseToMessage(message, bid, status) {
+    const adUnitCode = parseAdUnitCode(bid);
+    message.adUnits[adUnitCode] = message.adUnits[adUnitCode] || {};
+    const bidder = parseBidderCode(bid);
+    const bidResponse = this.serializeBidResponse(bid, status);
+    message.adUnits[adUnitCode][bidder] = bidResponse;
+  },
+  createBidMessage(auctionEndArgs, winningBids, timeoutBids) {
     const {auctionId, timestamp, timeout, auctionEnd, adUnitCodes, bidsReceived, noBids} = auctionEndArgs;
-    const message = this.newCommonMessageBody(auctionId);
+    const message = this.createCommonMessage(auctionId);
 
     message.auctionElapsed = (auctionEnd - timestamp);
     message.timeout = timeout;
@@ -137,26 +144,9 @@ export const appierAnalyticsAdapter = Object.assign(adapter({DEFAULT_SERVER, ana
       message.adUnits[adUnitCode] = {};
     });
 
-    bidsReceived.forEach((bid) => {
-      const adUnitCode = parseAdUnitCode(bid);
-      const bidder = parseBidderCode(bid);
-      const bidResponse = this.serializeBidResponse(bid, BIDDER_STATUS.BID);
-      message.adUnits[adUnitCode][bidder] = bidResponse;
-    });
-
-    noBids.forEach((bid) => {
-      const adUnitCode = parseAdUnitCode(bid);
-      const bidder = parseBidderCode(bid);
-      const bidResponse = this.serializeBidResponse(bid, BIDDER_STATUS.NO_BID);
-      message.adUnits[adUnitCode][bidder] = bidResponse;
-    });
-
-    timeoutBids.forEach((bid) => {
-      const adUnitCode = parseAdUnitCode(bid);
-      const bidder = parseBidderCode(bid);
-      const bidResponse = this.serializeBidResponse(bid, BIDDER_STATUS.TIMEOUT);
-      message.adUnits[adUnitCode][bidder] = bidResponse;
-    });
+    bidsReceived.forEach(bid => this.addBidResponseToMessage(message, bid, BIDDER_STATUS.BID));
+    noBids.forEach(bid => this.addBidResponseToMessage(message, bid, BIDDER_STATUS.NO_BID));
+    timeoutBids.forEach(bid => this.addBidResponseToMessage(message, bid, BIDDER_STATUS.TIMEOUT));
 
     // mark the winning bids with prebidWon = true
     winningBids.forEach(bid => {
@@ -166,17 +156,13 @@ export const appierAnalyticsAdapter = Object.assign(adapter({DEFAULT_SERVER, ana
     });
     return message;
   },
-  newImpressionMessageBody(bid) {
-    const message = this.newCommonMessageBody(bid.auctionId);
-    const adUnitCode = parseAdUnitCode(bid);
-    message.adUnits[adUnitCode] = {};
-    const bidder = parseBidderCode(bid);
-    const bidResponse = this.serializeBidResponse(bid, BIDDER_STATUS.BID_WON);
-    message.adUnits[adUnitCode][bidder] = bidResponse;
+  createImpressionMessage(bid) {
+    const message = this.createCommonMessage(bid.auctionId);
+    this.addBidResponseToMessage(message, bid, BIDDER_STATUS.BID_WON);
     return message;
   },
-  newCreativeMessageBody(auctionId, bids) {
-    const message = this.newCommonMessageBody(auctionId);
+  createCreativeMessage(auctionId, bids) {
+    const message = this.createCommonMessage(auctionId);
     bids.forEach((bid) => {
       const adUnitCode = parseAdUnitCode(bid);
       const bidder = parseBidderCode(bid);
@@ -196,13 +182,13 @@ export const appierAnalyticsAdapter = Object.assign(adapter({DEFAULT_SERVER, ana
     const highestCpmBids = pbjs.getHighestCpmBids();
 
     this.sendEventMessage('bid',
-      this.newAuctionMessageBody(auctionEndArgs, highestCpmBids, cachedAuction.timeoutBids)
+      this.createBidMessage(auctionEndArgs, highestCpmBids, cachedAuction.timeoutBids)
     );
 
     if (analyticsOptions.adSampled) {
       // FIXME: do not send the message if there are no creatives at all to safe bandwidth
       this.sendEventMessage('cr',
-        this.newCreativeMessageBody(auctionEndArgs.auctionId, auctionEndArgs.bidsReceived)
+        this.createCreativeMessage(auctionEndArgs.auctionId, auctionEndArgs.bidsReceived)
       );
     }
   },
@@ -213,7 +199,7 @@ export const appierAnalyticsAdapter = Object.assign(adapter({DEFAULT_SERVER, ana
     });
   },
   handleBidWon(bidWonArgs) {
-    this.sendEventMessage('imp', this.newImpressionMessageBody(bidWonArgs));
+    this.sendEventMessage('imp', this.createImpressionMessage(bidWonArgs));
   },
   track({eventType, args}) {
     if (analyticsOptions.sampled) {

test/spec/modules/appierAnalyticsAdapter_spec.js

@@ -5,22 +5,14 @@ import {expect} from 'chai';
 import * as ajax from 'src/ajax';
 
 const events = require('src/events');
-const constants = require('src/constants.json');
 
 const affiliateId = 'WhctHaViHtI';
 const configId = 'd9cc9a9b-e9b2-40ed-a17c-f1c9a8a4b29c';
 const serverUrl = 'https://analytics.server.url/v1';
 const autoPick = 'none';
-const hzid = 'WhctHaV9';
 const auctionId = 'b0b39610-b941-4659-a87c-de9f62d3e13e';
-const bidderCode = 'appier';
-const timeout = 2000;
-const auctionStart = Date.now();
 
 describe('Appier Prebid AnalyticsAdapter', function () {
-  let requests;
-  let cache;
-
   describe('event tracking and message cache manager', function () {
     let ajaxStub;
 
@@ -39,7 +31,6 @@ describe('Appier Prebid AnalyticsAdapter', function () {
         options: configOptions
       });
 
-      requests = [];
       sinon.stub(events, 'getEvents').returns([]);
 
       ajaxStub = sinon.stub(ajax, 'ajax').callsFake(function (url, callbacks) {
@@ -164,16 +155,15 @@ describe('Appier Prebid AnalyticsAdapter', function () {
         });
       }
 
-      describe('#newCommonMessageBody', function() {
+      describe('#createCommonMessage', function() {
         it('should correctly serialize some common fields', function() {
-          const message = appierAnalyticsAdapter.newCommonMessageBody(auctionId);
+          const message = appierAnalyticsAdapter.createCommonMessage(auctionId);
 
           assertHavingRequiredMessageFields(message);
         });
       });
 
       describe('#serializeBidResponse', function() {
-
         it('should handle BID properly and serialize bid price related fields', function() {
           const result = appierAnalyticsAdapter.serializeBidResponse(receivedBids[0], BIDDER_STATUS.BID);
 
@@ -227,7 +217,26 @@ describe('Appier Prebid AnalyticsAdapter', function () {
         });
       });
 
-      describe('#newAuctionMessageBody()', function() {
+      describe('#addBidResponseToMessage()', function() {
+        it('should add a bid response in the output message, grouped by adunit_id and bidder', function() {
+          const message = {
+            adUnits: {}
+          };
+          appierAnalyticsAdapter.addBidResponseToMessage(message, noBids[0], BIDDER_STATUS.NO_BID);
+
+          expect(message.adUnits).to.deep.include({
+            'adunit_2': {
+              'appier': {
+                prebidWon: false,
+                isTimeout: false,
+                status: BIDDER_STATUS.NO_BID,
+              }
+            }
+          });
+        });
+      });
+
+      describe('#createBidMessage()', function() {
         it('should format auction message sent to the backend', function() {
           const args = {
             auctionId: auctionId,
@@ -239,7 +248,7 @@ describe('Appier Prebid AnalyticsAdapter', function () {
             noBids: noBids
           };
 
-          const result = appierAnalyticsAdapter.newAuctionMessageBody(args, highestCpmBids, timeoutBids);
+          const result = appierAnalyticsAdapter.createBidMessage(args, highestCpmBids, timeoutBids);
 
           assertHavingRequiredMessageFields(result);
           expect(result).to.deep.include({
@@ -287,10 +296,10 @@ describe('Appier Prebid AnalyticsAdapter', function () {
         });
       });
 
-      describe('#newImpressionMessageBody()', function() {
+      describe('#createImpressionMessage()', function() {
         it('should format message sent to the backend with the bid result', function() {
           const bid = receivedBids[0];
-          const result = appierAnalyticsAdapter.newImpressionMessageBody(bid);
+          const result = appierAnalyticsAdapter.createImpressionMessage(bid);
 
           assertHavingRequiredMessageFields(result);
           expect(result.adUnits).to.deep.include({
@@ -311,9 +320,9 @@ describe('Appier Prebid AnalyticsAdapter', function () {
         });
       });
 
-      describe('#newCreativeMessageBody()', function() {
+      describe('#createCreativeMessage()', function() {
         it('should generate message sent to the backend with ad html grouped by adunit and bidder', function() {
-          const result = appierAnalyticsAdapter.newCreativeMessageBody(auctionId, receivedBids);
+          const result = appierAnalyticsAdapter.createCreativeMessage(auctionId, receivedBids);
 
           assertHavingRequiredMessageFields(result);
           expect(result.adUnits).to.deep.include({
@@ -338,7 +347,6 @@ describe('Appier Prebid AnalyticsAdapter', function () {
 
   describe('enableAnalytics and config parser', function () {
     beforeEach(function () {
-      requests = [];
       sinon.stub(events, 'getEvents').returns([]);
     });