From 33762d1ee5abd0363e2b35fbbb07cb2d38287972 Mon Sep 17 00:00:00 2001
From: Harshad Mane <harshad.mane@pubmatic.com>
Date: Thu, 12 Sep 2019 16:38:12 -0700
Subject: [PATCH 01/18] added support for pubcommon, digitrust, id5id

---
 modules/pubmaticBidAdapter.js | 21 +++++++++++++++++++++
 1 file changed, 21 insertions(+)

diff --git a/modules/pubmaticBidAdapter.js b/modules/pubmaticBidAdapter.js
index facecdaa578..2ec353a2f4e 100644
--- a/modules/pubmaticBidAdapter.js
+++ b/modules/pubmaticBidAdapter.js
@@ -624,10 +624,31 @@ function _handleTTDId(eids, validBidRequests) {
   }
 }
 
+/**
+ * Produces external userid object in ortb 3.0 model.
+ */
+function _addExternalUserId(eids, value, source, atype) {
+  if (value) {
+    eids.push({
+      source,
+      uids: [{
+        id: value,
+        atype
+      }]
+    });
+  }
+}
+
 function _handleEids(payload, validBidRequests) {
   let eids = [];
   _handleDigitrustId(eids);
   _handleTTDId(eids, validBidRequests);
+  const bidRequest = validBidRequests[0];
+  if(bidRequest && bidRequest.userId){
+    _addExternalUserId(eids, bidRequest.userId.pubcid, 'pubcommon', 1);
+    _addExternalUserId(eids, utils.deepAccess(bidRequest.userId.digitrustid, 'data.id'), 'digitru.st', 1);
+    _addExternalUserId(eids, bidRequest.userId.id5id, 'id5id', 1);
+  }
   if (eids.length > 0) {
     payload.user.eids = eids;
   }

From 0722354d7e62dc2237e16f8b7f469557ef388a20 Mon Sep 17 00:00:00 2001
From: Harshad Mane <harshad.mane@pubmatic.com>
Date: Thu, 12 Sep 2019 20:11:24 -0700
Subject: [PATCH 02/18] added support for IdentityLink

---
 modules/pubmaticBidAdapter.js | 10 ++++++----
 1 file changed, 6 insertions(+), 4 deletions(-)

diff --git a/modules/pubmaticBidAdapter.js b/modules/pubmaticBidAdapter.js
index 2ec353a2f4e..8c72367ba6e 100644
--- a/modules/pubmaticBidAdapter.js
+++ b/modules/pubmaticBidAdapter.js
@@ -644,10 +644,12 @@ function _handleEids(payload, validBidRequests) {
   _handleDigitrustId(eids);
   _handleTTDId(eids, validBidRequests);
   const bidRequest = validBidRequests[0];
-  if(bidRequest && bidRequest.userId){
-    _addExternalUserId(eids, bidRequest.userId.pubcid, 'pubcommon', 1);
-    _addExternalUserId(eids, utils.deepAccess(bidRequest.userId.digitrustid, 'data.id'), 'digitru.st', 1);
-    _addExternalUserId(eids, bidRequest.userId.id5id, 'id5id', 1);
+  if (bidRequest && bidRequest.userId) {
+    _addExternalUserId(eids, utils.deepAccess(bidRequest, `userId.pubcid`), 'pubcommon', 1);
+    _addExternalUserId(eids, utils.deepAccess(bidRequest, `userId.digitrustid.data.id`), 'digitru.st', 1);
+    _addExternalUserId(eids, utils.deepAccess(bidRequest, `userId.id5id`), 'id5id', 1);
+    _addExternalUserId(eids, utils.deepAccess(bidRequest, `userId.criteortus.${BIDDER_CODE}.userid`), 'criteortus', 1);
+    _addExternalUserId(eids, utils.deepAccess(bidRequest, `userId.idl_env`), 'identity_link_envelope', 1);
   }
   if (eids.length > 0) {
     payload.user.eids = eids;

From f2c32c07b4a4996e1e7d59510974c07d2eec7d5e Mon Sep 17 00:00:00 2001
From: Harshad Mane <harshad.mane@pubmatic.com>
Date: Fri, 13 Sep 2019 10:02:20 -0700
Subject: [PATCH 03/18] changed the source for id5

---
 modules/pubmaticBidAdapter.js | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/modules/pubmaticBidAdapter.js b/modules/pubmaticBidAdapter.js
index 8c72367ba6e..c768583b96c 100644
--- a/modules/pubmaticBidAdapter.js
+++ b/modules/pubmaticBidAdapter.js
@@ -647,7 +647,7 @@ function _handleEids(payload, validBidRequests) {
   if (bidRequest && bidRequest.userId) {
     _addExternalUserId(eids, utils.deepAccess(bidRequest, `userId.pubcid`), 'pubcommon', 1);
     _addExternalUserId(eids, utils.deepAccess(bidRequest, `userId.digitrustid.data.id`), 'digitru.st', 1);
-    _addExternalUserId(eids, utils.deepAccess(bidRequest, `userId.id5id`), 'id5id', 1);
+    _addExternalUserId(eids, utils.deepAccess(bidRequest, `userId.id5id`), 'id5-sync.com', 1);
     _addExternalUserId(eids, utils.deepAccess(bidRequest, `userId.criteortus.${BIDDER_CODE}.userid`), 'criteortus', 1);
     _addExternalUserId(eids, utils.deepAccess(bidRequest, `userId.idl_env`), 'identity_link_envelope', 1);
   }

From eaed9874c1fc91d79118b148bbd740569e562023 Mon Sep 17 00:00:00 2001
From: Harshad Mane <harshad.mane@pubmatic.com>
Date: Fri, 13 Sep 2019 14:19:36 -0700
Subject: [PATCH 04/18] added unit test cases

---
 modules/pubmaticBidAdapter.js                |   2 +-
 test/spec/modules/pubmaticBidAdapter_spec.js | 186 +++++++++++++++++++
 2 files changed, 187 insertions(+), 1 deletion(-)

diff --git a/modules/pubmaticBidAdapter.js b/modules/pubmaticBidAdapter.js
index c768583b96c..a85a2c8e19c 100644
--- a/modules/pubmaticBidAdapter.js
+++ b/modules/pubmaticBidAdapter.js
@@ -628,7 +628,7 @@ function _handleTTDId(eids, validBidRequests) {
  * Produces external userid object in ortb 3.0 model.
  */
 function _addExternalUserId(eids, value, source, atype) {
-  if (value) {
+  if (utils.isStr(value)) {
     eids.push({
       source,
       uids: [{
diff --git a/test/spec/modules/pubmaticBidAdapter_spec.js b/test/spec/modules/pubmaticBidAdapter_spec.js
index 3de83c56213..d0d0ce8c08b 100644
--- a/test/spec/modules/pubmaticBidAdapter_spec.js
+++ b/test/spec/modules/pubmaticBidAdapter_spec.js
@@ -1476,6 +1476,192 @@ describe('PubMatic adapter', function () {
         });
       });
 
+      describe('UserIds from request', function() {
+        describe('pubcommon Id', function() {
+          it('send the pubcommon id if it is present', function() {
+            bidRequests[0].userId = {};
+            bidRequests[0].userId.pubcid = 'pub_common_user_id';
+            let request = spec.buildRequests(bidRequests, {});
+            let data = JSON.parse(request.data);
+            expect(data.user.eids).to.deep.equal([{
+              'source': 'pubcommon',
+              'uids': [{
+                'id': 'pub_common_user_id',
+                'atype': 1
+              }]
+            }]);
+          });
+
+          it('do not pass if not string', function() {
+            bidRequests[0].userId = {};
+            bidRequests[0].userId.pubcid = 1;
+            let request = spec.buildRequests(bidRequests, {});
+            let data = JSON.parse(request.data);
+            expect(data.user.eids).to.equal(undefined);
+            bidRequests[0].userId.pubcid = [];
+            request = spec.buildRequests(bidRequests, {});
+            data = JSON.parse(request.data);
+            expect(data.user.eids).to.equal(undefined);
+            bidRequests[0].userId.pubcid = null;
+            request = spec.buildRequests(bidRequests, {});
+            data = JSON.parse(request.data);
+            expect(data.user.eids).to.equal(undefined);
+            bidRequests[0].userId.pubcid = {};
+            request = spec.buildRequests(bidRequests, {});
+            data = JSON.parse(request.data);
+            expect(data.user.eids).to.equal(undefined);
+          });
+        });
+
+        describe('Digitrust Id', function() {
+          it('send the digitrust id if it is present', function() {
+            bidRequests[0].userId = {};
+            bidRequests[0].userId.digitrustid = {data: {id: 'digitrust_user_id'}};
+            let request = spec.buildRequests(bidRequests, {});
+            let data = JSON.parse(request.data);
+            expect(data.user.eids).to.deep.equal([{
+              'source': 'digitru.st',
+              'uids': [{
+                'id': 'digitrust_user_id',
+                'atype': 1
+              }]
+            }]);
+          });
+
+          it('do not pass if not string', function() {
+            bidRequests[0].userId = {};
+            bidRequests[0].userId.digitrustid = {data: {id: 1}};
+            let request = spec.buildRequests(bidRequests, {});
+            let data = JSON.parse(request.data);
+            expect(data.user.eids).to.equal(undefined);
+            bidRequests[0].userId.digitrustid = {data: {id: []}};
+            request = spec.buildRequests(bidRequests, {});
+            data = JSON.parse(request.data);
+            expect(data.user.eids).to.equal(undefined);
+            bidRequests[0].userId.digitrustid = {data: {id: null}};
+            request = spec.buildRequests(bidRequests, {});
+            data = JSON.parse(request.data);
+            expect(data.user.eids).to.equal(undefined);
+            bidRequests[0].userId.digitrustid = {data: {id: {}}};
+            request = spec.buildRequests(bidRequests, {});
+            data = JSON.parse(request.data);
+            expect(data.user.eids).to.equal(undefined);
+          });
+        });
+
+        describe('ID5 Id', function() {
+          it('send the id5 id if it is present', function() {
+            bidRequests[0].userId = {};
+            bidRequests[0].userId.id5id = 'id5-user-id';
+            let request = spec.buildRequests(bidRequests, {});
+            let data = JSON.parse(request.data);
+            expect(data.user.eids).to.deep.equal([{
+              'source': 'id5-sync.com',
+              'uids': [{
+                'id': 'id5-user-id',
+                'atype': 1
+              }]
+            }]);
+          });
+
+          it('do not pass if not string', function() {
+            bidRequests[0].userId = {};
+            bidRequests[0].userId.id5id = 1;
+            let request = spec.buildRequests(bidRequests, {});
+            let data = JSON.parse(request.data);
+            expect(data.user.eids).to.equal(undefined);
+            bidRequests[0].userId.id5id = [];
+            request = spec.buildRequests(bidRequests, {});
+            data = JSON.parse(request.data);
+            expect(data.user.eids).to.equal(undefined);
+            bidRequests[0].userId.id5id = null;
+            request = spec.buildRequests(bidRequests, {});
+            data = JSON.parse(request.data);
+            expect(data.user.eids).to.equal(undefined);
+            bidRequests[0].userId.id5id = {};
+            request = spec.buildRequests(bidRequests, {});
+            data = JSON.parse(request.data);
+            expect(data.user.eids).to.equal(undefined);
+          });
+        });
+
+        describe('CriteoRTUS Id', function() {
+          it('send the criteo id if it is present', function() {
+            bidRequests[0].userId = {};
+            bidRequests[0].userId.criteortus = {pubmatic: {userid: 'criteo-rtus-user-id'}};
+            let request = spec.buildRequests(bidRequests, {});
+            let data = JSON.parse(request.data);
+            expect(data.user.eids).to.deep.equal([{
+              'source': 'criteortus',
+              'uids': [{
+                'id': 'criteo-rtus-user-id',
+                'atype': 1
+              }]
+            }]);
+          });
+
+          it('do not pass if not string', function() {
+            bidRequests[0].userId = {};
+            bidRequests[0].userId.criteortus = {appnexus: {userid: 'criteo-rtus-user-id'}};
+            let request = spec.buildRequests(bidRequests, {});
+            let data = JSON.parse(request.data);
+            expect(data.user.eids).to.equal(undefined);
+            bidRequests[0].userId.criteortus = {pubmatic: {userid: 1}};
+            request = spec.buildRequests(bidRequests, {});
+            data = JSON.parse(request.data);
+            expect(data.user.eids).to.equal(undefined);
+            bidRequests[0].userId.criteortus = {pubmatic: {userid: []}};
+            request = spec.buildRequests(bidRequests, {});
+            data = JSON.parse(request.data);
+            expect(data.user.eids).to.equal(undefined);
+            bidRequests[0].userId.criteortus = {pubmatic: {userid: null}};
+            request = spec.buildRequests(bidRequests, {});
+            data = JSON.parse(request.data);
+            expect(data.user.eids).to.equal(undefined);
+            bidRequests[0].userId.criteortus = {pubmatic: {userid: {}}};
+            request = spec.buildRequests(bidRequests, {});
+            data = JSON.parse(request.data);
+            expect(data.user.eids).to.equal(undefined);
+          });
+        });
+
+        describe('IdentityLink Id', function() {
+          it('send the identity-link id if it is present', function() {
+            bidRequests[0].userId = {};
+            bidRequests[0].userId.idl_env = 'identity-link-user-id';
+            let request = spec.buildRequests(bidRequests, {});
+            let data = JSON.parse(request.data);
+            expect(data.user.eids).to.deep.equal([{
+              'source': 'identity_link_envelope',
+              'uids': [{
+                'id': 'identity-link-user-id',
+                'atype': 1
+              }]
+            }]);
+          });
+
+          it('do not pass if not string', function() {
+            bidRequests[0].userId = {};
+            bidRequests[0].userId.idl_env = 1;
+            let request = spec.buildRequests(bidRequests, {});
+            let data = JSON.parse(request.data);
+            expect(data.user.eids).to.equal(undefined);
+            bidRequests[0].userId.idl_env = [];
+            request = spec.buildRequests(bidRequests, {});
+            data = JSON.parse(request.data);
+            expect(data.user.eids).to.equal(undefined);
+            bidRequests[0].userId.idl_env = null;
+            request = spec.buildRequests(bidRequests, {});
+            data = JSON.parse(request.data);
+            expect(data.user.eids).to.equal(undefined);
+            bidRequests[0].userId.idl_env = {};
+            request = spec.buildRequests(bidRequests, {});
+            data = JSON.parse(request.data);
+            expect(data.user.eids).to.equal(undefined);
+          });
+        });
+      })
+
       it('Request params check for video ad', function () {
         let request = spec.buildRequests(videoBidRequests);
         let data = JSON.parse(request.data);

From 602ee7ea83c07cf1ff83f6c000473512a9525b4c Mon Sep 17 00:00:00 2001
From: Harshad Mane <harshad.mane@pubmatic.com>
Date: Mon, 16 Sep 2019 14:24:27 -0700
Subject: [PATCH 05/18] changed source param for identityLink

---
 modules/pubmaticBidAdapter.js                | 2 +-
 test/spec/modules/pubmaticBidAdapter_spec.js | 2 +-
 2 files changed, 2 insertions(+), 2 deletions(-)

diff --git a/modules/pubmaticBidAdapter.js b/modules/pubmaticBidAdapter.js
index a85a2c8e19c..d1e1d072673 100644
--- a/modules/pubmaticBidAdapter.js
+++ b/modules/pubmaticBidAdapter.js
@@ -649,7 +649,7 @@ function _handleEids(payload, validBidRequests) {
     _addExternalUserId(eids, utils.deepAccess(bidRequest, `userId.digitrustid.data.id`), 'digitru.st', 1);
     _addExternalUserId(eids, utils.deepAccess(bidRequest, `userId.id5id`), 'id5-sync.com', 1);
     _addExternalUserId(eids, utils.deepAccess(bidRequest, `userId.criteortus.${BIDDER_CODE}.userid`), 'criteortus', 1);
-    _addExternalUserId(eids, utils.deepAccess(bidRequest, `userId.idl_env`), 'identity_link_envelope', 1);
+    _addExternalUserId(eids, utils.deepAccess(bidRequest, `userId.idl_env`), 'liveramp.com', 1);
   }
   if (eids.length > 0) {
     payload.user.eids = eids;
diff --git a/test/spec/modules/pubmaticBidAdapter_spec.js b/test/spec/modules/pubmaticBidAdapter_spec.js
index d0d0ce8c08b..ababf2dcf5f 100644
--- a/test/spec/modules/pubmaticBidAdapter_spec.js
+++ b/test/spec/modules/pubmaticBidAdapter_spec.js
@@ -1632,7 +1632,7 @@ describe('PubMatic adapter', function () {
             let request = spec.buildRequests(bidRequests, {});
             let data = JSON.parse(request.data);
             expect(data.user.eids).to.deep.equal([{
-              'source': 'identity_link_envelope',
+              'source': 'liveramp.com',
               'uids': [{
                 'id': 'identity-link-user-id',
                 'atype': 1

From 4fa60662263619a3c9805f6790d067c849a1cfcd Mon Sep 17 00:00:00 2001
From: Harshad Mane <harshad.mane@pubmatic.com>
Date: Fri, 22 May 2020 12:55:44 -0700
Subject: [PATCH 06/18] set gross ecpm using originalCpm

---
 modules/pubmaticAnalyticsAdapter.js | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/modules/pubmaticAnalyticsAdapter.js b/modules/pubmaticAnalyticsAdapter.js
index 9d2f45159e9..e113b5dd566 100755
--- a/modules/pubmaticAnalyticsAdapter.js
+++ b/modules/pubmaticAnalyticsAdapter.js
@@ -175,7 +175,7 @@ function gatherPartnerBidsForAdUnitForLogger(adUnit, adUnitId) {
       'kgpv': bid.params.kgpv ? bid.params.kgpv : adUnitId,
       'kgpsv': bid.params.kgpv ? bid.params.kgpv : adUnitId,
       'psz': bid.bidResponse ? (bid.bidResponse.dimensions.width + 'x' + bid.bidResponse.dimensions.height) : '0x0',
-      'eg': bid.bidResponse ? bid.bidResponse.bidPriceUSD : 0, // todo: later we will need to consider grossECPM and netECPM, precision
+      'eg': bid.bidResponse ? bid.bidResponse.originalCpm : 0, // todo: later we will need to consider grossECPM and netECPM, precision
       'en': bid.bidResponse ? bid.bidResponse.bidPriceUSD : 0, // todo: later we will need to consider grossECPM and netECPM, precision
       'di': bid.bidResponse ? (bid.bidResponse.dealId || EMPTY_STRING) : EMPTY_STRING,
       'dc': bid.bidResponse ? (bid.bidResponse.dealChannel || EMPTY_STRING) : EMPTY_STRING,

From 50f24cb0a2171daa7bd006b98ec643b9d5b06ea3 Mon Sep 17 00:00:00 2001
From: Harshad Mane <harshad.mane@pubmatic.com>
Date: Tue, 26 May 2020 18:00:01 -0700
Subject: [PATCH 07/18] using bidGrossCpmUSD to set eg

---
 modules/pubmaticAnalyticsAdapter.js | 20 ++++++++++++++++----
 1 file changed, 16 insertions(+), 4 deletions(-)

diff --git a/modules/pubmaticAnalyticsAdapter.js b/modules/pubmaticAnalyticsAdapter.js
index e113b5dd566..f8cce2d6ea8 100755
--- a/modules/pubmaticAnalyticsAdapter.js
+++ b/modules/pubmaticAnalyticsAdapter.js
@@ -126,6 +126,18 @@ function parseBidResponse(bid) {
       }
       utils.logWarn(LOG_PRE_FIX + 'Could not determine the bidPriceUSD of the bid ', bid);
     },
+    'bidGrossCpmUSD', () => {
+      // todo: check whether currency cases are handled here
+      if (typeof bid.originalCurrency === 'string' && bid.originalCurrency.toUpperCase() === CURRENCY_USD) {
+        return window.parseFloat(Number(bid.originalCpm).toFixed(BID_PRECISION));
+      }
+      // some new function was used in floor module, we need to check it
+      // use currency conversion function if present
+      if (typeof getGlobal().convertCurrency === 'function') {
+        return window.parseFloat(Number(getGlobal().convertCurrency( bid.originalCpm, bid.originalCurrency, CURRENCY_USD)).toFixed(BID_PRECISION));
+      }
+      utils.logWarn(LOG_PRE_FIX + 'Could not determine the bidPriceUSD of the bid ', bid);
+    },
     'dealId',
     'currency',
     'cpm', () => window.parseFloat(Number(bid.cpm).toFixed(BID_PRECISION)),
@@ -175,8 +187,8 @@ function gatherPartnerBidsForAdUnitForLogger(adUnit, adUnitId) {
       'kgpv': bid.params.kgpv ? bid.params.kgpv : adUnitId,
       'kgpsv': bid.params.kgpv ? bid.params.kgpv : adUnitId,
       'psz': bid.bidResponse ? (bid.bidResponse.dimensions.width + 'x' + bid.bidResponse.dimensions.height) : '0x0',
-      'eg': bid.bidResponse ? bid.bidResponse.originalCpm : 0, // todo: later we will need to consider grossECPM and netECPM, precision
-      'en': bid.bidResponse ? bid.bidResponse.bidPriceUSD : 0, // todo: later we will need to consider grossECPM and netECPM, precision
+      'eg': bid.bidResponse ? bid.bidResponse.bidGrossCpmUSD : 0,
+      'en': bid.bidResponse ? bid.bidResponse.bidPriceUSD : 0,
       'di': bid.bidResponse ? (bid.bidResponse.dealId || EMPTY_STRING) : EMPTY_STRING,
       'dc': bid.bidResponse ? (bid.bidResponse.dealChannel || EMPTY_STRING) : EMPTY_STRING,
       'l1': bid.bidResponse ? bid.clientLatencyTimeMs : 0,
@@ -263,8 +275,8 @@ function executeBidWonLoggerCall(auctionId, adUnitId) {
   pixelURL += '&pdvid=' + enc(profileVersionId);
   pixelURL += '&slot=' + enc(adUnitId);
   pixelURL += '&pn=' + enc(winningBid.bidder);
-  pixelURL += '&en=' + enc(winningBid.bidResponse.bidPriceUSD); // todo: later we will need to consider grossECPM and netECPM
-  pixelURL += '&eg=' + enc(winningBid.bidResponse.bidPriceUSD); // todo: later we will need to consider grossECPM and netECPM
+  pixelURL += '&en=' + enc(winningBid.bidResponse.bidPriceUSD);
+  pixelURL += '&eg=' + enc(winningBid.bidResponse.bidGrossCpmUSD);
   pixelURL += '&kgpv=' + enc(winningBid.params.kgpv || adUnitId);
   ajax(
     pixelURL,

From f6b4843d58d8706a711aaf08016a4954b805ce4a Mon Sep 17 00:00:00 2001
From: Harshad Mane <harshad.mane@pubmatic.com>
Date: Tue, 26 May 2020 18:24:20 -0700
Subject: [PATCH 08/18] lint

---
 modules/pubmaticAnalyticsAdapter.js | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/modules/pubmaticAnalyticsAdapter.js b/modules/pubmaticAnalyticsAdapter.js
index f8cce2d6ea8..f3f2c2b36e4 100755
--- a/modules/pubmaticAnalyticsAdapter.js
+++ b/modules/pubmaticAnalyticsAdapter.js
@@ -4,6 +4,7 @@ import CONSTANTS from '../src/constants.json';
 import { ajax } from '../src/ajax.js';
 import { config } from '../src/config.js';
 import * as utils from '../src/utils.js';
+import { getGlobal } from '../src/prebidGlobal.js';
 
 /// /////////// CONSTANTS //////////////
 const ADAPTER_CODE = 'pubmatic';
@@ -134,7 +135,7 @@ function parseBidResponse(bid) {
       // some new function was used in floor module, we need to check it
       // use currency conversion function if present
       if (typeof getGlobal().convertCurrency === 'function') {
-        return window.parseFloat(Number(getGlobal().convertCurrency( bid.originalCpm, bid.originalCurrency, CURRENCY_USD)).toFixed(BID_PRECISION));
+        return window.parseFloat(Number(getGlobal().convertCurrency(bid.originalCpm, bid.originalCurrency, CURRENCY_USD)).toFixed(BID_PRECISION));
       }
       utils.logWarn(LOG_PRE_FIX + 'Could not determine the bidPriceUSD of the bid ', bid);
     },

From 3cbc5ed1cec4a6bea23caa352164a11fcff3d0f6 Mon Sep 17 00:00:00 2001
From: Harshad Mane <harshad.mane@pubmatic.com>
Date: Tue, 26 May 2020 18:26:12 -0700
Subject: [PATCH 09/18] fixed old cases

---
 test/spec/modules/pubmaticAnalyticsAdapter_spec.js | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/test/spec/modules/pubmaticAnalyticsAdapter_spec.js b/test/spec/modules/pubmaticAnalyticsAdapter_spec.js
index e9d23692d23..1fc0290e26e 100755
--- a/test/spec/modules/pubmaticAnalyticsAdapter_spec.js
+++ b/test/spec/modules/pubmaticAnalyticsAdapter_spec.js
@@ -538,7 +538,7 @@ describe('pubmatic analytics adapter', function () {
       expect(data.s[1].ps[0].kgpv).to.equal('this-is-a-kgpv');
       expect(data.s[1].ps[0].kgpsv).to.equal('this-is-a-kgpv');
       expect(data.s[1].ps[0].psz).to.equal('728x90');
-      expect(data.s[1].ps[0].eg).to.equal(undefined); // bidPriceUSD is not getting set as currency module is not added
+      expect(data.s[1].ps[0].eg).to.equal(1);
       expect(data.s[1].ps[0].en).to.equal(undefined); // bidPriceUSD is not getting set as currency module is not added
       expect(data.s[1].ps[0].di).to.equal('the-deal-id');
       expect(data.s[1].ps[0].dc).to.equal('PMP');
@@ -552,5 +552,5 @@ describe('pubmatic analytics adapter', function () {
       expect(data.s[1].ps[0].ocpm).to.equal(100);
       expect(data.s[1].ps[0].ocry).to.equal('JPY');
     });
-  })
+  });
 });

From dcc791e3de15e25cc8ab2e8105e6612c49248524 Mon Sep 17 00:00:00 2001
From: Harshad Mane <harshad.mane@pubmatic.com>
Date: Wed, 27 May 2020 16:54:46 -0700
Subject: [PATCH 10/18] added some tests

---
 .../modules/pubmaticAnalyticsAdapter_spec.js  | 115 ++++++++++++++++++
 1 file changed, 115 insertions(+)

diff --git a/test/spec/modules/pubmaticAnalyticsAdapter_spec.js b/test/spec/modules/pubmaticAnalyticsAdapter_spec.js
index 1fc0290e26e..cb8a72e7232 100755
--- a/test/spec/modules/pubmaticAnalyticsAdapter_spec.js
+++ b/test/spec/modules/pubmaticAnalyticsAdapter_spec.js
@@ -1,6 +1,7 @@
 import pubmaticAnalyticsAdapter from 'modules/pubmaticAnalyticsAdapter.js';
 import CONSTANTS from 'src/constants.json';
 import { config } from 'src/config.js';
+import * as prebidGlobal from 'src/prebidGlobal.js';
 import {
   setConfig,
   addBidResponseHook,
@@ -290,6 +291,7 @@ describe('pubmatic analytics adapter', function () {
 
     afterEach(function () {
       pubmaticAnalyticsAdapter.disableAnalytics();
+      // pbjs.bidderSettings = {};
     });
 
     it('Logger: best case + win tracker', function() {
@@ -387,6 +389,119 @@ describe('pubmatic analytics adapter', function () {
       expect(data.en).to.equal('1.23');
     });
 
+    it('bidCpmAdjustment: USD: Logger: best case + win tracker', function() {
+      const bidCopy = utils.deepClone(BID);
+      bidCopy.cpm = bidCopy.originalCpm * 2; //  bidCpmAdjustment => bidCpm * 2
+
+      events.emit(AUCTION_INIT, MOCK.AUCTION_INIT);
+      events.emit(BID_REQUESTED, MOCK.BID_REQUESTED);
+      // events.emit(BID_RESPONSE, MOCK.BID_RESPONSE[0]);
+      events.emit(BID_RESPONSE, bidCopy);
+      events.emit(BID_RESPONSE, MOCK.BID_RESPONSE[1]);
+      events.emit(BID_RESPONSE, bidCopy);
+      events.emit(BIDDER_DONE, MOCK.BIDDER_DONE);
+      events.emit(AUCTION_END, MOCK.AUCTION_END);
+      events.emit(SET_TARGETING, MOCK.SET_TARGETING);
+      events.emit(BID_WON, MOCK.BID_WON[0]);
+      events.emit(BID_WON, MOCK.BID_WON[1]);
+
+      clock.tick(2000 + 1000);
+      expect(requests.length).to.equal(3); // 1 logger and 2 win-tracker
+      let request = requests[2]; // logger is executed late, trackers execute first
+      expect(request.url).to.equal('https://t.pubmatic.com/wl?pubid=9999&gdEn=1');
+      let data = getLoggerJsonFromRequest(request.requestBody);
+      expect(data.pubid).to.equal('9999');
+      expect(data.pid).to.equal('1111');
+      expect(data.s).to.be.an('array');
+      expect(data.s.length).to.equal(2);
+      // slot 1
+      expect(data.s[0].sn).to.equal('/19968336/header-bid-tag-0');
+      expect(data.s[0].sz).to.deep.equal(['640x480']);
+      expect(data.s[0].ps).to.be.an('array');
+      expect(data.s[0].ps.length).to.equal(1);
+      expect(data.s[0].ps[0].pn).to.equal('pubmatic');
+      expect(data.s[0].ps[0].bidid).to.equal('2ecff0db240757');
+      expect(data.s[0].ps[0].kgpv).to.equal('/19968336/header-bid-tag-0');
+      expect(data.s[0].ps[0].eg).to.equal(1.23);
+      expect(data.s[0].ps[0].en).to.equal(2.46);
+      expect(data.s[0].ps[0].wb).to.equal(1);
+      expect(data.s[0].ps[0].af).to.equal('video');
+      expect(data.s[0].ps[0].ocpm).to.equal(1.23);
+      expect(data.s[0].ps[0].ocry).to.equal('USD');
+      // tracker slot1
+      let firstTracker = requests[0].url;
+      expect(firstTracker.split('?')[0]).to.equal('https://t.pubmatic.com/wt');
+      data = {};
+      firstTracker.split('?')[1].split('&').map(e => e.split('=')).forEach(e => data[e[0]] = e[1]);
+      expect(data.pubid).to.equal('9999');
+      expect(data.tst).to.equal('1519767014');
+      expect(data.iid).to.equal('25c6d7f5-699a-4bfc-87c9-996f915341fa');
+      expect(data.eg).to.equal('1.23');
+      expect(data.en).to.equal('2.46');
+    });
+
+    it('bidCpmAdjustment: JPY: Logger: best case + win tracker', function() {
+      setConfig({
+        adServerCurrency: 'JPY',
+        rates: {
+          USD: {
+            JPY: 100
+          }
+        }
+      });
+      const bidCopy = utils.deepClone(BID);
+      bidCopy.originalCpm = 100;
+      bidCopy.originalCurrency = 'JPY';
+      bidCopy.currency = 'JPY';
+      bidCopy.cpm = bidCopy.originalCpm * 2; //  bidCpmAdjustment => bidCpm * 2
+
+      events.emit(AUCTION_INIT, MOCK.AUCTION_INIT);
+      events.emit(BID_REQUESTED, MOCK.BID_REQUESTED);
+      // events.emit(BID_RESPONSE, MOCK.BID_RESPONSE[0]);
+      events.emit(BID_RESPONSE, bidCopy);
+      events.emit(BID_RESPONSE, MOCK.BID_RESPONSE[1]);
+      events.emit(BID_RESPONSE, bidCopy);
+      events.emit(BIDDER_DONE, MOCK.BIDDER_DONE);
+      events.emit(AUCTION_END, MOCK.AUCTION_END);
+      events.emit(SET_TARGETING, MOCK.SET_TARGETING);
+      events.emit(BID_WON, MOCK.BID_WON[0]);
+      events.emit(BID_WON, MOCK.BID_WON[1]);
+
+      clock.tick(2000 + 1000);
+      expect(requests.length).to.equal(3); // 1 logger and 2 win-tracker
+      let request = requests[2]; // logger is executed late, trackers execute first
+      expect(request.url).to.equal('https://t.pubmatic.com/wl?pubid=9999&gdEn=1');
+      let data = getLoggerJsonFromRequest(request.requestBody);
+      expect(data.pubid).to.equal('9999');
+      expect(data.pid).to.equal('1111');
+      expect(data.s).to.be.an('array');
+      expect(data.s.length).to.equal(2);
+      // slot 1
+      expect(data.s[0].sn).to.equal('/19968336/header-bid-tag-0');
+      expect(data.s[0].sz).to.deep.equal(['640x480']);
+      expect(data.s[0].ps).to.be.an('array');
+      expect(data.s[0].ps.length).to.equal(1);
+      expect(data.s[0].ps[0].pn).to.equal('pubmatic');
+      expect(data.s[0].ps[0].bidid).to.equal('2ecff0db240757');
+      expect(data.s[0].ps[0].kgpv).to.equal('/19968336/header-bid-tag-0');
+      expect(data.s[0].ps[0].eg).to.equal(1);
+      expect(data.s[0].ps[0].en).to.equal(undefined); // bidPriceUSD is not getting set as currency module is not added
+      expect(data.s[0].ps[0].wb).to.equal(0); // bidPriceUSD is not getting set as currency module is not added, so unable to set wb to 1
+      expect(data.s[0].ps[0].af).to.equal('video');
+      expect(data.s[0].ps[0].ocpm).to.equal(100);
+      expect(data.s[0].ps[0].ocry).to.equal('JPY');
+      // tracker slot1
+      let firstTracker = requests[0].url;
+      expect(firstTracker.split('?')[0]).to.equal('https://t.pubmatic.com/wt');
+      data = {};
+      firstTracker.split('?')[1].split('&').map(e => e.split('=')).forEach(e => data[e[0]] = e[1]);
+      expect(data.pubid).to.equal('9999');
+      expect(data.tst).to.equal('1519767014');
+      expect(data.iid).to.equal('25c6d7f5-699a-4bfc-87c9-996f915341fa');
+      expect(data.eg).to.equal('1');
+      expect(data.en).to.equal('undefined'); // bidPriceUSD is not getting set as currency module is not added
+    });
+
     it('Logger: when bid is not submitted, default bid status 1 check: pubmatic set as s2s', function() {
       events.emit(AUCTION_INIT, MOCK.AUCTION_INIT);
       events.emit(BID_REQUESTED, MOCK.BID_REQUESTED);

From 5cef98755813cd55c231b45c22a3f2d90f636f18 Mon Sep 17 00:00:00 2001
From: Harshad Mane <harshad.mane@pubmatic.com>
Date: Thu, 28 May 2020 20:24:40 -0700
Subject: [PATCH 11/18] removed comments

---
 modules/pubmaticAnalyticsAdapter.js | 2 --
 1 file changed, 2 deletions(-)

diff --git a/modules/pubmaticAnalyticsAdapter.js b/modules/pubmaticAnalyticsAdapter.js
index f3f2c2b36e4..8ed8f5c3c7e 100755
--- a/modules/pubmaticAnalyticsAdapter.js
+++ b/modules/pubmaticAnalyticsAdapter.js
@@ -128,11 +128,9 @@ function parseBidResponse(bid) {
       utils.logWarn(LOG_PRE_FIX + 'Could not determine the bidPriceUSD of the bid ', bid);
     },
     'bidGrossCpmUSD', () => {
-      // todo: check whether currency cases are handled here
       if (typeof bid.originalCurrency === 'string' && bid.originalCurrency.toUpperCase() === CURRENCY_USD) {
         return window.parseFloat(Number(bid.originalCpm).toFixed(BID_PRECISION));
       }
-      // some new function was used in floor module, we need to check it
       // use currency conversion function if present
       if (typeof getGlobal().convertCurrency === 'function') {
         return window.parseFloat(Number(getGlobal().convertCurrency(bid.originalCpm, bid.originalCurrency, CURRENCY_USD)).toFixed(BID_PRECISION));

From b9cdce44452d34cc718855d334bf9aba2c21105b Mon Sep 17 00:00:00 2001
From: Harshad Mane <harshad.mane@pubmatic.com>
Date: Thu, 28 May 2020 20:29:20 -0700
Subject: [PATCH 12/18] removed commented code , and unused import

---
 test/spec/modules/pubmaticAnalyticsAdapter_spec.js | 3 ---
 1 file changed, 3 deletions(-)

diff --git a/test/spec/modules/pubmaticAnalyticsAdapter_spec.js b/test/spec/modules/pubmaticAnalyticsAdapter_spec.js
index cb8a72e7232..1b90b8b0786 100755
--- a/test/spec/modules/pubmaticAnalyticsAdapter_spec.js
+++ b/test/spec/modules/pubmaticAnalyticsAdapter_spec.js
@@ -1,7 +1,6 @@
 import pubmaticAnalyticsAdapter from 'modules/pubmaticAnalyticsAdapter.js';
 import CONSTANTS from 'src/constants.json';
 import { config } from 'src/config.js';
-import * as prebidGlobal from 'src/prebidGlobal.js';
 import {
   setConfig,
   addBidResponseHook,
@@ -291,7 +290,6 @@ describe('pubmatic analytics adapter', function () {
 
     afterEach(function () {
       pubmaticAnalyticsAdapter.disableAnalytics();
-      // pbjs.bidderSettings = {};
     });
 
     it('Logger: best case + win tracker', function() {
@@ -395,7 +393,6 @@ describe('pubmatic analytics adapter', function () {
 
       events.emit(AUCTION_INIT, MOCK.AUCTION_INIT);
       events.emit(BID_REQUESTED, MOCK.BID_REQUESTED);
-      // events.emit(BID_RESPONSE, MOCK.BID_RESPONSE[0]);
       events.emit(BID_RESPONSE, bidCopy);
       events.emit(BID_RESPONSE, MOCK.BID_RESPONSE[1]);
       events.emit(BID_RESPONSE, bidCopy);

From e9302a0d6f7f7cb33d5f102274e83b57bbdb62d8 Mon Sep 17 00:00:00 2001
From: Harshad Mane <harshad.mane@pubmatic.com>
Date: Fri, 29 May 2020 10:55:29 -0700
Subject: [PATCH 13/18] en related changes in test cases

---
 test/spec/modules/pubmaticAnalyticsAdapter_spec.js | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/test/spec/modules/pubmaticAnalyticsAdapter_spec.js b/test/spec/modules/pubmaticAnalyticsAdapter_spec.js
index 1b90b8b0786..f7be07ea1cc 100755
--- a/test/spec/modules/pubmaticAnalyticsAdapter_spec.js
+++ b/test/spec/modules/pubmaticAnalyticsAdapter_spec.js
@@ -482,7 +482,7 @@ describe('pubmatic analytics adapter', function () {
       expect(data.s[0].ps[0].bidid).to.equal('2ecff0db240757');
       expect(data.s[0].ps[0].kgpv).to.equal('/19968336/header-bid-tag-0');
       expect(data.s[0].ps[0].eg).to.equal(1);
-      expect(data.s[0].ps[0].en).to.equal(undefined); // bidPriceUSD is not getting set as currency module is not added
+      expect(data.s[0].ps[0].en).to.equal(200);
       expect(data.s[0].ps[0].wb).to.equal(0); // bidPriceUSD is not getting set as currency module is not added, so unable to set wb to 1
       expect(data.s[0].ps[0].af).to.equal('video');
       expect(data.s[0].ps[0].ocpm).to.equal(100);
@@ -496,7 +496,7 @@ describe('pubmatic analytics adapter', function () {
       expect(data.tst).to.equal('1519767014');
       expect(data.iid).to.equal('25c6d7f5-699a-4bfc-87c9-996f915341fa');
       expect(data.eg).to.equal('1');
-      expect(data.en).to.equal('undefined'); // bidPriceUSD is not getting set as currency module is not added
+      expect(data.en).to.equal('200'); // bidPriceUSD is not getting set as currency module is not added
     });
 
     it('Logger: when bid is not submitted, default bid status 1 check: pubmatic set as s2s', function() {
@@ -651,7 +651,7 @@ describe('pubmatic analytics adapter', function () {
       expect(data.s[1].ps[0].kgpsv).to.equal('this-is-a-kgpv');
       expect(data.s[1].ps[0].psz).to.equal('728x90');
       expect(data.s[1].ps[0].eg).to.equal(1);
-      expect(data.s[1].ps[0].en).to.equal(undefined); // bidPriceUSD is not getting set as currency module is not added
+      expect(data.s[1].ps[0].en).to.equal(100);
       expect(data.s[1].ps[0].di).to.equal('the-deal-id');
       expect(data.s[1].ps[0].dc).to.equal('PMP');
       expect(data.s[1].ps[0].mi).to.equal('matched-impression');

From 81935610a7573bd949740e9a5fc7a8de32231de2 Mon Sep 17 00:00:00 2001
From: Harshad Mane <harshad.mane@pubmatic.com>
Date: Sun, 31 May 2020 20:50:28 -0700
Subject: [PATCH 14/18] using pbjs.getHighestCpmBids, added test cases around
 it

---
 modules/pubmaticAnalyticsAdapter.js           | 24 ++++++-------------
 .../modules/pubmaticAnalyticsAdapter_spec.js  | 23 +++++++++++++++++-
 2 files changed, 29 insertions(+), 18 deletions(-)

diff --git a/modules/pubmaticAnalyticsAdapter.js b/modules/pubmaticAnalyticsAdapter.js
index 8ed8f5c3c7e..b23c14e320a 100755
--- a/modules/pubmaticAnalyticsAdapter.js
+++ b/modules/pubmaticAnalyticsAdapter.js
@@ -125,7 +125,8 @@ function parseBidResponse(bid) {
       if (typeof bid.getCpmInNewCurrency === 'function') {
         return window.parseFloat(Number(bid.getCpmInNewCurrency(CURRENCY_USD)).toFixed(BID_PRECISION));
       }
-      utils.logWarn(LOG_PRE_FIX + 'Could not determine the bidPriceUSD of the bid ', bid);
+      utils.logWarn(LOG_PRE_FIX + 'Could not determine the Net cpm in USD for the bid thus using bid.cpm', bid);
+      return bid.cpm
     },
     'bidGrossCpmUSD', () => {
       if (typeof bid.originalCurrency === 'string' && bid.originalCurrency.toUpperCase() === CURRENCY_USD) {
@@ -135,7 +136,8 @@ function parseBidResponse(bid) {
       if (typeof getGlobal().convertCurrency === 'function') {
         return window.parseFloat(Number(getGlobal().convertCurrency(bid.originalCpm, bid.originalCurrency, CURRENCY_USD)).toFixed(BID_PRECISION));
       }
-      utils.logWarn(LOG_PRE_FIX + 'Could not determine the bidPriceUSD of the bid ', bid);
+      utils.logWarn(LOG_PRE_FIX + 'Could not determine the Gross cpm in USD for the bid, thus using bid.originalCpm', bid);
+      return bid.originalCpm
     },
     'dealId',
     'currency',
@@ -163,20 +165,9 @@ function getDomainFromUrl(url) {
   return a.hostname;
 }
 
-function getHighestBidForAdUnit(adUnit) {
-  return Object.keys(adUnit.bids).reduce(function(currentHighestBid, bidId) {
-    // todo: later we will need to consider grossECPM and netECPM
-    let bid = adUnit.bids[bidId];
-    if (bid.bidResponse && bid.bidResponse.bidPriceUSD > currentHighestBid.bidPriceUSD) {
-      currentHighestBid.bidPriceUSD = bid.bidResponse.bidPriceUSD;
-      currentHighestBid.bidId = bidId;
-    }
-    return currentHighestBid;
-  }, {bidId: '', bidPriceUSD: 0});
-}
-
 function gatherPartnerBidsForAdUnitForLogger(adUnit, adUnitId) {
-  const highestsBid = getHighestBidForAdUnit(adUnit);
+  let highestBid = $$PREBID_GLOBAL$$.getHighestCpmBids([adUnitId]);
+  highestBid = (highestBid && highestBid.length > 0) ? highestBid[0] : null;
   return Object.keys(adUnit.bids).reduce(function(partnerBids, bidId) {
     let bid = adUnit.bids[bidId];
     partnerBids.push({
@@ -192,10 +183,9 @@ function gatherPartnerBidsForAdUnitForLogger(adUnit, adUnitId) {
       'dc': bid.bidResponse ? (bid.bidResponse.dealChannel || EMPTY_STRING) : EMPTY_STRING,
       'l1': bid.bidResponse ? bid.clientLatencyTimeMs : 0,
       'l2': 0,
-      // 'ss': (bid.source === 'server' ? 1 : 0), // todo: is there any special handling required as per OW?
       'ss': (s2sBidders.indexOf(bid.bidder) > -1) ? 1 : 0,
       't': (bid.status == ERROR && bid.error.code == TIMEOUT_ERROR) ? 1 : 0,
-      'wb': highestsBid.bidId === bid.bidId ? 1 : 0,
+      'wb': (highestBid && highestBid.requestId === bid.bidId ? 1 : 0),
       'mi': bid.bidResponse ? (bid.bidResponse.mi || undefined) : undefined,
       'af': bid.bidResponse ? (bid.bidResponse.mediaType || undefined) : undefined,
       'ocpm': bid.bidResponse ? (bid.bidResponse.originalCpm || 0) : 0,
diff --git a/test/spec/modules/pubmaticAnalyticsAdapter_spec.js b/test/spec/modules/pubmaticAnalyticsAdapter_spec.js
index f7be07ea1cc..058484f4015 100755
--- a/test/spec/modules/pubmaticAnalyticsAdapter_spec.js
+++ b/test/spec/modules/pubmaticAnalyticsAdapter_spec.js
@@ -293,6 +293,13 @@ describe('pubmatic analytics adapter', function () {
     });
 
     it('Logger: best case + win tracker', function() {
+      sandbox.stub($$PREBID_GLOBAL$$, 'getHighestCpmBids').callsFake((key) => {
+        var config = {};
+        config[MOCK.BID_RESPONSE[0].adUnitCode] = [MOCK.BID_RESPONSE[0]];
+        config[MOCK.BID_RESPONSE[1].adUnitCode] = [MOCK.BID_RESPONSE[1]];
+        return config[key];
+      });
+
       events.emit(AUCTION_INIT, MOCK.AUCTION_INIT);
       events.emit(BID_REQUESTED, MOCK.BID_REQUESTED);
       events.emit(BID_RESPONSE, MOCK.BID_RESPONSE[0]);
@@ -391,6 +398,13 @@ describe('pubmatic analytics adapter', function () {
       const bidCopy = utils.deepClone(BID);
       bidCopy.cpm = bidCopy.originalCpm * 2; //  bidCpmAdjustment => bidCpm * 2
 
+      sandbox.stub($$PREBID_GLOBAL$$, 'getHighestCpmBids').callsFake((key) => {
+        var config = {};
+        config[MOCK.BID_RESPONSE[0].adUnitCode] = [bidCopy];
+        config[MOCK.BID_RESPONSE[1].adUnitCode] = [MOCK.BID_RESPONSE[1]];
+        return config[key];
+      });
+
       events.emit(AUCTION_INIT, MOCK.AUCTION_INIT);
       events.emit(BID_REQUESTED, MOCK.BID_REQUESTED);
       events.emit(BID_RESPONSE, bidCopy);
@@ -575,6 +589,13 @@ describe('pubmatic analytics adapter', function () {
 
     it('Logger: post-timeout check with bid response', function() {
       // db = 1 and t = 1 means bidder did NOT respond with a bid but we got a timeout notification
+
+      sandbox.stub($$PREBID_GLOBAL$$, 'getHighestCpmBids').callsFake((key) => {
+        var config = {};
+        config[MOCK.BID_RESPONSE[1].adUnitCode] = [MOCK.BID_RESPONSE[1]];
+        return config[key];
+      });
+
       events.emit(AUCTION_INIT, MOCK.AUCTION_INIT);
       events.emit(BID_REQUESTED, MOCK.BID_REQUESTED);
       events.emit(BID_RESPONSE, MOCK.BID_RESPONSE[1]);
@@ -604,7 +625,7 @@ describe('pubmatic analytics adapter', function () {
       expect(data.s[1].ps[0].l2).to.equal(0);
       expect(data.s[1].ps[0].ss).to.equal(1);
       expect(data.s[1].ps[0].t).to.equal(1);
-      expect(data.s[1].ps[0].wb).to.equal(1);
+      expect(data.s[1].ps[0].wb).to.equal(1); // todo
       expect(data.s[1].ps[0].af).to.equal('banner');
       expect(data.s[1].ps[0].ocpm).to.equal(1.52);
       expect(data.s[1].ps[0].ocry).to.equal('USD');

From e3f83dc6760864524aeba545e95e5484218adb8c Mon Sep 17 00:00:00 2001
From: Harshad Mane <harshad.mane@pubmatic.com>
Date: Wed, 3 Jun 2020 22:16:36 -0700
Subject: [PATCH 15/18] passing highestCpmBids

---
 modules/pubmaticAnalyticsAdapter.js | 11 ++++++-----
 1 file changed, 6 insertions(+), 5 deletions(-)

diff --git a/modules/pubmaticAnalyticsAdapter.js b/modules/pubmaticAnalyticsAdapter.js
index b23c14e320a..b5686c56d6e 100755
--- a/modules/pubmaticAnalyticsAdapter.js
+++ b/modules/pubmaticAnalyticsAdapter.js
@@ -165,8 +165,7 @@ function getDomainFromUrl(url) {
   return a.hostname;
 }
 
-function gatherPartnerBidsForAdUnitForLogger(adUnit, adUnitId) {
-  let highestBid = $$PREBID_GLOBAL$$.getHighestCpmBids([adUnitId]);
+function gatherPartnerBidsForAdUnitForLogger(adUnit, adUnitId, highestBid) {
   highestBid = (highestBid && highestBid.length > 0) ? highestBid[0] : null;
   return Object.keys(adUnit.bids).reduce(function(partnerBids, bidId) {
     let bid = adUnit.bids[bidId];
@@ -195,7 +194,8 @@ function gatherPartnerBidsForAdUnitForLogger(adUnit, adUnitId) {
   }, [])
 }
 
-function executeBidsLoggerCall(auctionId) {
+function executeBidsLoggerCall(e, highestCpmBids) {
+  let auctionId = e.auctionId;
   let referrer = config.getConfig('pageUrl') || cache.auctions[auctionId].referer || '';
   let auctionCache = cache.auctions[auctionId];
   let outputObj = { s: [] };
@@ -231,7 +231,7 @@ function executeBidsLoggerCall(auctionId) {
     let slotObject = {
       'sn': adUnitId,
       'sz': adUnit.dimensions.map(e => e[0] + 'x' + e[1]),
-      'ps': gatherPartnerBidsForAdUnitForLogger(adUnit, adUnitId)
+      'ps': gatherPartnerBidsForAdUnitForLogger(adUnit, adUnitId, highestCpmBids.filter(bid => bid.adUnitCode === adUnitId))
     };
     slotsArray.push(slotObject);
     return slotsArray;
@@ -346,8 +346,9 @@ function bidWonHandler(args) {
 
 function auctionEndHandler(args) {
   // if for the given auction bidderDonePendingCount == 0 then execute logger call sooners
+  let highestCpmBids = $$PREBID_GLOBAL$$.getHighestCpmBids();
   setTimeout(() => {
-    executeBidsLoggerCall.call(this, args.auctionId);
+    executeBidsLoggerCall.call(this, args, highestCpmBids);
   }, (cache.auctions[args.auctionId].bidderDonePendingCount === 0 ? 500 : SEND_TIMEOUT));
 }
 

From f58ce1a7f895a1b255af43156d4e4d033ee8d0bf Mon Sep 17 00:00:00 2001
From: Harshad Mane <harshad.mane@pubmatic.com>
Date: Wed, 3 Jun 2020 22:31:54 -0700
Subject: [PATCH 16/18] fixed test cases

---
 modules/pubmaticAnalyticsAdapter.js                |  2 +-
 test/spec/modules/pubmaticAnalyticsAdapter_spec.js | 14 +++-----------
 2 files changed, 4 insertions(+), 12 deletions(-)

diff --git a/modules/pubmaticAnalyticsAdapter.js b/modules/pubmaticAnalyticsAdapter.js
index b5686c56d6e..4ef607fd3e4 100755
--- a/modules/pubmaticAnalyticsAdapter.js
+++ b/modules/pubmaticAnalyticsAdapter.js
@@ -346,7 +346,7 @@ function bidWonHandler(args) {
 
 function auctionEndHandler(args) {
   // if for the given auction bidderDonePendingCount == 0 then execute logger call sooners
-  let highestCpmBids = $$PREBID_GLOBAL$$.getHighestCpmBids();
+  let highestCpmBids = $$PREBID_GLOBAL$$.getHighestCpmBids() || [];
   setTimeout(() => {
     executeBidsLoggerCall.call(this, args, highestCpmBids);
   }, (cache.auctions[args.auctionId].bidderDonePendingCount === 0 ? 500 : SEND_TIMEOUT));
diff --git a/test/spec/modules/pubmaticAnalyticsAdapter_spec.js b/test/spec/modules/pubmaticAnalyticsAdapter_spec.js
index 058484f4015..bb9aa20f1b4 100755
--- a/test/spec/modules/pubmaticAnalyticsAdapter_spec.js
+++ b/test/spec/modules/pubmaticAnalyticsAdapter_spec.js
@@ -294,10 +294,7 @@ describe('pubmatic analytics adapter', function () {
 
     it('Logger: best case + win tracker', function() {
       sandbox.stub($$PREBID_GLOBAL$$, 'getHighestCpmBids').callsFake((key) => {
-        var config = {};
-        config[MOCK.BID_RESPONSE[0].adUnitCode] = [MOCK.BID_RESPONSE[0]];
-        config[MOCK.BID_RESPONSE[1].adUnitCode] = [MOCK.BID_RESPONSE[1]];
-        return config[key];
+        return [MOCK.BID_RESPONSE[0], MOCK.BID_RESPONSE[1]]
       });
 
       events.emit(AUCTION_INIT, MOCK.AUCTION_INIT);
@@ -399,10 +396,7 @@ describe('pubmatic analytics adapter', function () {
       bidCopy.cpm = bidCopy.originalCpm * 2; //  bidCpmAdjustment => bidCpm * 2
 
       sandbox.stub($$PREBID_GLOBAL$$, 'getHighestCpmBids').callsFake((key) => {
-        var config = {};
-        config[MOCK.BID_RESPONSE[0].adUnitCode] = [bidCopy];
-        config[MOCK.BID_RESPONSE[1].adUnitCode] = [MOCK.BID_RESPONSE[1]];
-        return config[key];
+        return [bidCopy, MOCK.BID_RESPONSE[1]]
       });
 
       events.emit(AUCTION_INIT, MOCK.AUCTION_INIT);
@@ -591,9 +585,7 @@ describe('pubmatic analytics adapter', function () {
       // db = 1 and t = 1 means bidder did NOT respond with a bid but we got a timeout notification
 
       sandbox.stub($$PREBID_GLOBAL$$, 'getHighestCpmBids').callsFake((key) => {
-        var config = {};
-        config[MOCK.BID_RESPONSE[1].adUnitCode] = [MOCK.BID_RESPONSE[1]];
-        return config[key];
+        return [MOCK.BID_RESPONSE[1]]
       });
 
       events.emit(AUCTION_INIT, MOCK.AUCTION_INIT);

From 0fca0d8159eac4256aaab0a552822a507ff40ab7 Mon Sep 17 00:00:00 2001
From: Harshad Mane <harshad.mane@pubmatic.com>
Date: Tue, 9 Jun 2020 11:01:46 -0700
Subject: [PATCH 17/18] added notes

---
 modules/pubmaticAnalyticsAdapter.md | 3 +--
 1 file changed, 1 insertion(+), 2 deletions(-)

diff --git a/modules/pubmaticAnalyticsAdapter.md b/modules/pubmaticAnalyticsAdapter.md
index 9685f758ea2..097f0b3d792 100644
--- a/modules/pubmaticAnalyticsAdapter.md
+++ b/modules/pubmaticAnalyticsAdapter.md
@@ -20,5 +20,4 @@ pbjs.enableAnalytics({
 - Supports only Banner and Video media-type
 - Does not supports Native media type
 - Does not supports instream-video creative-render tracker
-- BidCpmAdjustment: Bid CPM only after BidCpmAdjustment is logged
-- If a currency module is NOT included and a bidder responds in a non-USD currency then PubMatic analytics bidder will not be able to log the bid CPM
\ No newline at end of file
+- If a currency module is NOT included and a bidder responds in a non-USD currency then PubMatic analytics bidder will log values in original bid currency otherwise always logged in USD
\ No newline at end of file

From ba572d01b16613c0ced2f3606b66bb71a0596397 Mon Sep 17 00:00:00 2001
From: Harshad Mane <harshad.mane@pubmatic.com>
Date: Wed, 10 Jun 2020 08:21:34 -0700
Subject: [PATCH 18/18] using getGlobal() instead of $$PREBID_GLOBAL$$

---
 modules/pubmaticAnalyticsAdapter.js | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/modules/pubmaticAnalyticsAdapter.js b/modules/pubmaticAnalyticsAdapter.js
index 4ef607fd3e4..a19c6f095ad 100755
--- a/modules/pubmaticAnalyticsAdapter.js
+++ b/modules/pubmaticAnalyticsAdapter.js
@@ -346,7 +346,7 @@ function bidWonHandler(args) {
 
 function auctionEndHandler(args) {
   // if for the given auction bidderDonePendingCount == 0 then execute logger call sooners
-  let highestCpmBids = $$PREBID_GLOBAL$$.getHighestCpmBids() || [];
+  let highestCpmBids = getGlobal().getHighestCpmBids() || [];
   setTimeout(() => {
     executeBidsLoggerCall.call(this, args, highestCpmBids);
   }, (cache.auctions[args.auctionId].bidderDonePendingCount === 0 ? 500 : SEND_TIMEOUT));