fix(greenbids,analytics): fetch bidder params when bid is valid

integrationExamples/gpt/x-domain/creative.html

@@ -2,7 +2,7 @@
 // creative will be rendered, e.g. GAM delivering a SafeFrame
 
 // this code is autogenerated, also available in 'build/creative/creative.js'
-<script>!function(){"use strict";const e="Prebid Event",n=(()=>{const e={frameBorder:0,scrolling:"no",marginHeight:0,marginWidth:0,topMargin:0,leftMargin:0,allowTransparency:"true"};return(n,t)=>{const r=n.createElement("iframe");return Object.entries(Object.assign({},t,e)).forEach((([e,n])=>r.setAttribute(e,n))),r}})();function t(e){return!!e.frames.__pb_locator__}window.pbRender=function(r){let o=r.parent;try{for(;o!==r.top&&!t(o);)o=o.parent;t(o)||(o=r.parent)}catch(e){}return function({adId:t,pubUrl:s,clickUrl:i}){const c=new URL(s,window.location).origin;function a(e,n,r){const s=new MessageChannel;s.port1.onmessage=u(r),o.postMessage(JSON.stringify(Object.assign({message:e,adId:t},n)),c,[s.port2])}function d(n){a(e,{event:"adRenderFailed",info:{reason:n?.reason||"exception",message:n?.message}}),n?.stack&&console.error(n)}function u(e){return function(){try{return e.apply(this,arguments)}catch(e){d(e)}}}a("Prebid Request",{options:{clickUrl:i}},(function(o){let s;try{s=JSON.parse(o.data)}catch(e){return}if("Prebid Response"===s.message&&s.adId===t){const t=n(r.document,{width:0,height:0,style:"display: none",srcdoc:`<script>${s.renderer}<\/script>`});t.onload=u((function(){const o=t.contentWindow;o.Promise.resolve(o.render(s,{sendMessage:a,mkFrame:n},r)).then((()=>a(e,{event:"adRenderSucceeded"})),d)})),r.document.body.appendChild(t)}}))}}(window)}();</script>
+<script>(()=>{"use strict";const e="Prebid Event",n=(()=>{const e={frameBorder:0,scrolling:"no",marginHeight:0,marginWidth:0,topMargin:0,leftMargin:0,allowTransparency:"true"};return(n,t)=>{const r=n.createElement("iframe");return Object.entries(Object.assign({},t,e)).forEach((([e,n])=>r.setAttribute(e,n))),r}})();function t(e){return!!e.frames.__pb_locator__}window.pbRender=function(r){let o=r.parent;try{for(;o!==r.top&&!t(o);)o=o.parent;t(o)||(o=r.parent)}catch(e){}return function({adId:t,pubUrl:s,clickUrl:i}){const a=new URL(s,window.location).origin;function c(e,n,r){const s=new MessageChannel;s.port1.onmessage=l(r),o.postMessage(JSON.stringify(Object.assign({message:e,adId:t},n)),a,[s.port2])}function d(n){c(e,{event:"adRenderFailed",info:{reason:n?.reason||"exception",message:n?.message}}),n?.stack&&console.error(n)}function l(e){return function(){try{return e.apply(this,arguments)}catch(e){d(e)}}}c("Prebid Request",{options:{clickUrl:i}},(function(o){let s;try{s=JSON.parse(o.data)}catch(e){return}if("Prebid Response"===s.message&&s.adId===t){const t=n(r.document,{width:0,height:0,style:"display: none",srcdoc:`<script>${s.renderer}<\/script>`});t.onload=l((function(){const o=t.contentWindow;o.Promise.resolve(o.render(s,{sendMessage:c,mkFrame:n},r)).then((()=>c(e,{event:"adRenderSucceeded"})),d)})),r.document.body.appendChild(t)}}))}}(window)})();</script>
 
 <script>
     pbRender({

modules/greenbidsAnalyticsAdapter.js

@@ -1,20 +1,40 @@
-import {ajax} from '../src/ajax.js';
+import { ajax } from '../src/ajax.js';
 import adapter from '../libraries/analyticsAdapter/AnalyticsAdapter.js';
 import { EVENTS } from '../src/constants.js';
 import adapterManager from '../src/adapterManager.js';
-import {deepClone, generateUUID, logError, logInfo, logWarn, getParameterByName} from '../src/utils.js';
+import { deepClone, generateUUID, logError, logInfo, logWarn, getParameterByName } from '../src/utils.js';
 
 /**
  * @typedef {import('../src/adapters/bidderFactory.js').Bid} Bid
+ * @typedef {import('../src/adapters/bidderFactory.js').BidRequest} BidRequest
  */
 
 /**
  * @typedef {object} Message Payload message sent to the Greenbids API
  */
 
+/**
+ * @typedef AuctionEndArgs
+ * @type {object}
+ * @property {string} auctionId
+ * @property {number} timestamp - Auction start epoch
+ * @property {number} auctionEnd - Auction end epoch
+ * @property {Bid[]} bidsReceived
+ * @property {BidRequest[]} noBids
+ */
+
+/**
+ * @typedef GreenbidsCachedOption
+ * @type {object}
+ * @property {any[]} timeoutBids
+ * @property {?string} greenbidsId
+ * @property {?string} billingId
+ * @property {boolean} isSampled
+ */
+
 const analyticsType = 'endpoint';
 
-export const ANALYTICS_VERSION = '2.3.2';
+export const ANALYTICS_VERSION = '2.3.3';
 
 const ANALYTICS_SERVER = 'https://a.greenbids.ai';
 
@@ -33,7 +53,7 @@ export const BIDDER_STATUS = {
 
 const analyticsOptions = {};
 
-export const isSampled = function(greenbidsId, samplingRate, exploratorySamplingSplit) {
+export const isSampled = function (greenbidsId, samplingRate, exploratorySamplingSplit) {
   const isSamplingForced = getParameterByName('greenbids_force_sampling');
   if (isSamplingForced) {
     logInfo('Greenbids Analytics: sampling flag detected, forcing analytics');
@@ -52,7 +72,7 @@ export const isSampled = function(greenbidsId, samplingRate, exploratorySampling
   return isExtraSampled;
 }
 
-export const greenbidsAnalyticsAdapter = Object.assign(adapter({ANALYTICS_SERVER, analyticsType}), {
+export const greenbidsAnalyticsAdapter = Object.assign(adapter({ ANALYTICS_SERVER, analyticsType }), {
 
   cachedAuctions: {},
   exploratorySamplingSplit: 0.9,
@@ -125,83 +145,82 @@ export const greenbidsAnalyticsAdapter = Object.assign(adapter({ANALYTICS_SERVER
     };
   },
   /**
-   * @param {Bid} bid
-   * @param {BIDDER_STATUS} status
-   */
-  serializeBidResponse(bid, status) {
-    return {
-      bidder: bid.bidder,
-      isTimeout: (status === BIDDER_STATUS.TIMEOUT),
-      hasBid: (status === BIDDER_STATUS.BID),
-      params: (bid.params && Object.keys(bid.params).length > 0) ? bid.params : {},
-      ...(status === BIDDER_STATUS.BID ? {
-        cpm: bid.cpm,
-        currency: bid.currency
-      } : {}),
-    };
-  },
-  /**
-   * @param {*} message Greenbids API payload
-   * @param {Bid} bid Bid to add to the payload
-   * @param {BIDDER_STATUS} status Bidding status
+   * @param {AuctionEndArgs} auctionEndArgs
+   * @param {GreenbidsCachedOption} cachedAuction
+   * @returns {Message}
    */
-  addBidResponseToMessage(message, bid, status) {
-    const adUnitCode = bid.adUnitCode.toLowerCase();
-    const adUnitIndex = message.adUnits.findIndex((adUnit) => {
-      return adUnit.code === adUnitCode;
-    });
-    if (adUnitIndex === -1) {
-      logError('Trying to add to non registered adunit');
-      return;
-    }
-    const bidderIndex = message.adUnits[adUnitIndex].bidders.findIndex((bidder) => {
-      return bidder.bidder === bid.bidder;
-    });
-    if (bidderIndex === -1) {
-      message.adUnits[adUnitIndex].bidders.push(this.serializeBidResponse(bid, status));
-    } else {
-      message.adUnits[adUnitIndex].bidders[bidderIndex].params = (bid.params && Object.keys(bid.params).length > 0) ? bid.params : {};
-      if (status === BIDDER_STATUS.BID) {
-        message.adUnits[adUnitIndex].bidders[bidderIndex].hasBid = true;
-        message.adUnits[adUnitIndex].bidders[bidderIndex].cpm = bid.cpm;
-        message.adUnits[adUnitIndex].bidders[bidderIndex].currency = bid.currency;
-      } else if (status === BIDDER_STATUS.TIMEOUT) {
-        message.adUnits[adUnitIndex].bidders[bidderIndex].isTimeout = true;
-      }
-    }
-  },
-  createBidMessage(auctionEndArgs) {
-    const {auctionId, timestamp, auctionEnd, adUnits, bidsReceived, noBids} = auctionEndArgs;
-    const cachedAuction = this.getCachedAuction(auctionId);
-    const message = this.createCommonMessage(auctionId);
-    const timeoutBids = cachedAuction.timeoutBids || [];
+  createBidMessage(auctionEndArgs, cachedAuction) {
+    const {
+      auctionId,
+      timestamp,
+      auctionEnd,
+      adUnits,
+      bidsReceived,
+      noBids
+    } = auctionEndArgs;
+    const timeoutBids = (cachedAuction || this.getCachedAuction(auctionId)).timeoutBids || [];
 
+    const message = this.createCommonMessage(auctionId);
     message.auctionElapsed = (auctionEnd - timestamp);
 
+    const biddersSubMessages = new Map()
+
     adUnits.forEach((adUnit) => {
       const adUnitCode = adUnit.code?.toLowerCase() || 'unknown_adunit_code';
       message.adUnits.push({
         code: adUnitCode,
         mediaTypes: {
-          ...(adUnit.mediaTypes?.banner !== undefined) && {banner: adUnit.mediaTypes.banner},
-          ...(adUnit.mediaTypes?.video !== undefined) && {video: adUnit.mediaTypes.video},
-          ...(adUnit.mediaTypes?.native !== undefined) && {native: adUnit.mediaTypes.native}
+          ...(adUnit.mediaTypes?.banner !== undefined) && { banner: adUnit.mediaTypes.banner },
+          ...(adUnit.mediaTypes?.video !== undefined) && { video: adUnit.mediaTypes.video },
+          ...(adUnit.mediaTypes?.native !== undefined) && { native: adUnit.mediaTypes.native }
         },
         ortb2Imp: adUnit.ortb2Imp || {},
-        bidders: [],
+
+        bidders: (adUnit.bids || []).map((bid) => {
+          const subMessage = {
+            bidder: bid.bidder,
+            params: (bid.params && Object.keys(bid.params).length > 0) ? bid.params : {},
+          }
+          biddersSubMessages.set((adUnitCode, bid.bidder), subMessage)
+          return subMessage
+        })
       });
     });
 
     // We enrich noBid then bids, then timeouts, because in case of a timeout, one response from a bidder
     // Can be in the 3 arrays, and we want that case reflected in the call
-    noBids.forEach(bid => this.addBidResponseToMessage(message, bid, BIDDER_STATUS.NO_BID));
-
-    bidsReceived.forEach(bid => this.addBidResponseToMessage(message, bid, BIDDER_STATUS.BID));
-
-    timeoutBids.forEach(bid => this.addBidResponseToMessage(message, bid, BIDDER_STATUS.TIMEOUT));
+    logInfo(noBids)
+    noBids.forEach(rqst => {
+      Object.assign(
+        biddersSubMessages.get((rqst.adUnitCode, rqst.bidder)) || {},
+        { hasBid: false }
+      )
+    })
+    logInfo(bidsReceived)
+    bidsReceived.forEach(bid => {
+      Object.assign(
+        biddersSubMessages.get((bid.adUnitCode, bid.bidder)) || {},
+        {
+          hasBid: true,
+          cpm: bid.cpm,
+          currency: bid.currency
+        }
+      )
+    })
+    logInfo(timeoutBids)
+    timeoutBids.forEach(badBid => {
+      Object.assign(
+        biddersSubMessages.get((badBid.adUnitCode, badBid.bidder)) || {},
+        { isTimeout: true }
+      )
+    });
 
     return message;
   },
+  /**
+   * @param {string} auctionId
+   * @returns {GreenbidsCachedOption}
+   */
   getCachedAuction(auctionId) {
     this.cachedAuctions[auctionId] = this.cachedAuctions[auctionId] || {
       timeoutBids: [],
@@ -221,6 +240,9 @@ export const greenbidsAnalyticsAdapter = Object.assign(adapter({ANALYTICS_SERVER
     }
     cachedAuction.isSampled = isSampled(cachedAuction.greenbidsId, analyticsOptions.options.greenbidsSampling, this.exploratorySamplingSplit);
   },
+  /**
+   * @param {AuctionEndArgs} auctionEndArgs
+   */
   handleAuctionEnd(auctionEndArgs) {
     const cachedAuction = this.getCachedAuction(auctionEndArgs.auctionId);
     const isFilteringForced = getParameterByName('greenbids_force_filtering');
@@ -243,7 +265,7 @@ export const greenbidsAnalyticsAdapter = Object.assign(adapter({ANALYTICS_SERVER
       cachedAuction.billingId = billableArgs.billingId || 'unknown_billing_id';
     }
   },
-  track({eventType, args}) {
+  track({ eventType, args }) {
     try {
       if (eventType === AUCTION_INIT) {
         this.handleAuctionInit(args);
@@ -273,7 +295,7 @@ export const greenbidsAnalyticsAdapter = Object.assign(adapter({ANALYTICS_SERVER
 
 greenbidsAnalyticsAdapter.originEnableAnalytics = greenbidsAnalyticsAdapter.enableAnalytics;
 
-greenbidsAnalyticsAdapter.enableAnalytics = function(config) {
+greenbidsAnalyticsAdapter.enableAnalytics = function (config) {
   this.initConfig(config);
   if (typeof config.options.sampling === 'number') {
     // Set sampling to 1 to prevent prebid analytics integrated sampling to happen

test/spec/modules/greenbidsAnalyticsAdapter_spec.js

@@ -107,7 +107,6 @@ describe('Greenbids Prebid AnalyticsAdapter Testing', function () {
           cpm: 0.08,
           currency: 'USD',
           ad: '<html>fake ad2</html>',
-          params: {'placement ID': 12784}
         },
         {
           auctionId: auctionId,
@@ -158,64 +157,6 @@ describe('Greenbids Prebid AnalyticsAdapter Testing', function () {
         });
       });
 
-      describe('#serializeBidResponse', function () {
-        it('should handle BID properly with timeout false and hasBid true', function () {
-          const result = greenbidsAnalyticsAdapter.serializeBidResponse(receivedBids[0], BIDDER_STATUS.BID);
-
-          expect(result).to.include({
-            bidder: 'greenbids',
-            isTimeout: false,
-            hasBid: true,
-          });
-        });
-
-        it('should handle NO_BID properly and set hasBid to false', function () {
-          const result = greenbidsAnalyticsAdapter.serializeBidResponse(noBids[0], BIDDER_STATUS.NO_BID);
-
-          expect(result).to.include({
-            bidder: 'greenbids',
-            isTimeout: false,
-            hasBid: false,
-          });
-        });
-
-        it('should handle TIMEOUT properly and set isTimeout to true', function () {
-          const result = greenbidsAnalyticsAdapter.serializeBidResponse(noBids[0], BIDDER_STATUS.TIMEOUT);
-
-          expect(result).to.include({
-            bidder: 'greenbids',
-            isTimeout: true,
-            hasBid: false,
-          });
-        });
-      });
-
-      describe('#addBidResponseToMessage()', function () {
-        it('should add a bid response in the output message, grouped by adunit_id and bidder', function () {
-          const message = {
-            adUnits: [
-              {
-                code: 'adunit-2',
-                bidders: []
-              }
-            ]
-          };
-          greenbidsAnalyticsAdapter.addBidResponseToMessage(message, noBids[0], BIDDER_STATUS.NO_BID);
-
-          expect(message.adUnits[0]).to.deep.include({
-            code: 'adunit-2',
-            bidders: [
-              {
-                bidder: 'greenbids',
-                isTimeout: false,
-                hasBid: false,
-                params: {}
-              }
-            ]
-          });
-        });
-      });
-
       describe('#createBidMessage()', function () {
         it('should format auction message sent to the backend', function () {
           const args = {
@@ -231,7 +172,10 @@ describe('Greenbids Prebid AnalyticsAdapter Testing', function () {
                   banner: {
                     sizes: [[300, 250], [300, 600]]
                   },
-                }
+                },
+                bids: [
+                  { bidder: "greenbidsx", params: { 'placement ID': 12784 } }
+                ]
               },
               {
                 code: 'adunit-2',
@@ -260,9 +204,7 @@ describe('Greenbids Prebid AnalyticsAdapter Testing', function () {
             noBids: noBids
           };
 
-          sinon.stub(greenbidsAnalyticsAdapter, 'getCachedAuction').returns({ timeoutBids: timeoutBids });
-          const result = greenbidsAnalyticsAdapter.createBidMessage(args, timeoutBids);
-          greenbidsAnalyticsAdapter.getCachedAuction.restore();
+          const result = greenbidsAnalyticsAdapter.createBidMessage(args, { timeoutBids: timeoutBids });
           assertHavingRequiredMessageFields(result);
           expect(result).to.deep.include({
             auctionElapsed: 100,