PubMatic adapter support to read TTD Id from UserId module (prebid#3834)

* in-dev

* added unit test cases

* adding isStr check on userId.tdid

* review suggestion

Author: pm-harshad-mane

modules/pubmaticBidAdapter.js

@@ -601,13 +601,20 @@ function _handleDigitrustId(eids) {
   }
 }
 
-function _handleTTDId(eids) {
+function _handleTTDId(eids, validBidRequests) {
+  let ttdId = null;
   let adsrvrOrgId = config.getConfig('adsrvrOrgId');
-  if (adsrvrOrgId && utils.isStr(adsrvrOrgId.TDID)) {
+  if (utils.isStr(utils.deepAccess(validBidRequests, '0.userId.tdid'))) {
+    ttdId = validBidRequests[0].userId.tdid;
+  } else if (adsrvrOrgId && utils.isStr(adsrvrOrgId.TDID)) {
+    ttdId = adsrvrOrgId.TDID;
+  }
+
+  if (ttdId !== null) {
     eids.push({
       'source': 'adserver.org',
       'uids': [{
-        'id': adsrvrOrgId.TDID,
+        'id': ttdId,
         'atype': 1,
         'ext': {
           'rtiPartner': 'TDID'
@@ -617,10 +624,10 @@ function _handleTTDId(eids) {
   }
 }
 
-function _handleEids(payload) {
+function _handleEids(payload, validBidRequests) {
   let eids = [];
   _handleDigitrustId(eids);
-  _handleTTDId(eids);
+  _handleTTDId(eids, validBidRequests);
   if (eids.length > 0) {
     payload.user.eids = eids;
   }
@@ -877,7 +884,7 @@ export const spec = {
       }
     }
 
-    _handleEids(payload);
+    _handleEids(payload, validBidRequests);
     _blockedIabCategoriesValidation(payload, blockedIabCategories);
     return {
       method: 'POST',

test/spec/modules/pubmaticBidAdapter_spec.js

@@ -1235,6 +1235,76 @@ describe('PubMatic adapter', function () {
         });
       });
 
+      describe('AdsrvrOrgId from userId module', function() {
+        let sandbox;
+        beforeEach(() => {
+          sandbox = sinon.sandbox.create();
+        });
+
+        afterEach(() => {
+          sandbox.restore();
+        });
+
+        it('Request should have AdsrvrOrgId config params', function() {
+          bidRequests[0].userId = {};
+          bidRequests[0].userId.tdid = 'TTD_ID_FROM_USER_ID_MODULE';
+          let request = spec.buildRequests(bidRequests, {});
+          let data = JSON.parse(request.data);
+          expect(data.user.eids).to.deep.equal([{
+            'source': 'adserver.org',
+            'uids': [{
+              'id': 'TTD_ID_FROM_USER_ID_MODULE',
+              'atype': 1,
+              'ext': {
+                'rtiPartner': 'TDID'
+              }
+            }]
+          }]);
+        });
+
+        it('Request should have adsrvrOrgId from UserId Module if config and userId module both have TTD ID', function() {
+          sandbox.stub(config, 'getConfig').callsFake((key) => {
+            var config = {
+              adsrvrOrgId: {
+                'TDID': 'TTD_ID_FROM_CONFIG',
+                'TDID_LOOKUP': 'TRUE',
+                'TDID_CREATED_AT': '2018-10-01T07:05:40'
+              }
+            };
+            return config[key];
+          });
+          bidRequests[0].userId = {};
+          bidRequests[0].userId.tdid = 'TTD_ID_FROM_USER_ID_MODULE';
+          let request = spec.buildRequests(bidRequests, {});
+          let data = JSON.parse(request.data);
+          expect(data.user.eids).to.deep.equal([{
+            'source': 'adserver.org',
+            'uids': [{
+              'id': 'TTD_ID_FROM_USER_ID_MODULE',
+              'atype': 1,
+              'ext': {
+                'rtiPartner': 'TDID'
+              }
+            }]
+          }]);
+        });
+
+        it('Request should NOT have adsrvrOrgId params if userId is NOT object', function() {
+          let request = spec.buildRequests(bidRequests, {});
+          let data = JSON.parse(request.data);
+          expect(data.user.eids).to.deep.equal(undefined);
+        });
+
+        it('Request should NOT have adsrvrOrgId params if userId.tdid is NOT string', function() {
+          bidRequests[0].userId = {
+            tdid: 1234
+          };
+          let request = spec.buildRequests(bidRequests, {});
+          let data = JSON.parse(request.data);
+          expect(data.user.eids).to.deep.equal(undefined);
+        });
+      });
+
       describe('AdsrvrOrgId and Digitrust', function() {
         // here we are considering cases only of accepting DigiTrustId from config
         let sandbox;