From da480f207e8d767017d71bab1bfa607279421b3f Mon Sep 17 00:00:00 2001
From: Samuel Adu <samuel.adu@gmail.com>
Date: Fri, 23 Oct 2020 04:01:02 +0100
Subject: [PATCH] AOL Adapter: User ID Support (#5886)

* Added support for passing VMUID to SSP endpoints

* Remove 'only' command

* Do not create user.ext object unless required

* Add support for passing Liveramp envelope to VM SSP

* WIP

* Updated tests

* Remove trailing comma

Co-authored-by: slimkrazy <sam@slimkrazy.com>
---
 modules/aolBidAdapter.js                | 34 +++++++++++++++
 test/spec/modules/aolBidAdapter_spec.js | 57 ++++++++++++++++++++++++-
 2 files changed, 90 insertions(+), 1 deletion(-)

diff --git a/modules/aolBidAdapter.js b/modules/aolBidAdapter.js
index 1f43231e495..93c56846639 100644
--- a/modules/aolBidAdapter.js
+++ b/modules/aolBidAdapter.js
@@ -30,6 +30,17 @@ const SYNC_TYPES = {
   }
 };
 
+const SUPPORTED_USER_ID_SOURCES = [
+  'adserver.org',
+  'criteo.com',
+  'id5-sync.com',
+  'intentiq.com',
+  'liveintent.com',
+  'quantcast.com',
+  'verizonmedia.com',
+  'liveramp.com'
+];
+
 const pubapiTemplate = template`${'host'}/pubapi/3.0/${'network'}/${'placement'}/${'pageid'}/${'sizeid'}/ADTECH;v=2;cmd=bid;cors=yes;alias=${'alias'};misc=${'misc'};${'dynamicParams'}`;
 const nexageBaseApiTemplate = template`${'host'}/bidRequest?`;
 const nexageGetApiTemplate = template`dcn=${'dcn'}&pos=${'pos'}&cmd=bid${'dynamicParams'}`;
@@ -103,6 +114,12 @@ function resolveEndpointCode(bid) {
   }
 }
 
+function getSupportedEids(bid) {
+  return bid.userIdAsEids.filter(eid => {
+    return SUPPORTED_USER_ID_SOURCES.includes(eid.source)
+  });
+}
+
 export const spec = {
   code: AOL_BIDDERS_CODES.AOL,
   gvlid: 25,
@@ -226,6 +243,13 @@ export const spec = {
   },
   buildOneMobileGetUrl(bid, consentData) {
     let { dcn, pos, ext } = bid.params;
+    if (typeof bid.userId === 'object') {
+      ext = ext || {};
+      let eids = getSupportedEids(bid);
+      eids.forEach(eid => {
+        ext['eid' + eid.source] = eid.uids[0].id;
+      });
+    }
     let nexageApi = this.buildOneMobileBaseUrl(bid);
     if (dcn && pos) {
       let dynamicParams = this.formatOneMobileDynamicParams(ext, consentData);
@@ -292,6 +316,16 @@ export const spec = {
       utils.deepSetValue(openRtbObject, 'regs.ext.us_privacy', consentData.uspConsent);
     }
 
+    if (typeof bid.userId === 'object') {
+      openRtbObject.user = openRtbObject.user || {};
+      openRtbObject.user.ext = openRtbObject.user.ext || {};
+
+      let eids = getSupportedEids(bid);
+      if (eids.length > 0) {
+        openRtbObject.user.ext.eids = eids
+      }
+    }
+
     return openRtbObject;
   },
   isEUConsentRequired(consentData) {
diff --git a/test/spec/modules/aolBidAdapter_spec.js b/test/spec/modules/aolBidAdapter_spec.js
index dd10a57bbfe..2276e32ece7 100644
--- a/test/spec/modules/aolBidAdapter_spec.js
+++ b/test/spec/modules/aolBidAdapter_spec.js
@@ -1,7 +1,7 @@
 import {expect} from 'chai';
 import * as utils from 'src/utils.js';
 import {spec} from 'modules/aolBidAdapter.js';
-import {config} from 'src/config.js';
+import {createEidsArray} from '../../../modules/userId/eids.js';
 
 const DEFAULT_AD_CONTENT = '<script>logInfo(\'ad\');</script>';
 
@@ -80,6 +80,33 @@ describe('AolAdapter', function () {
   const NEXAGE_URL = 'https://c2shb.ssp.yahoo.com/bidRequest?';
   const ONE_DISPLAY_TTL = 60;
   const ONE_MOBILE_TTL = 3600;
+  const SUPPORTED_USER_ID_SOURCES = {
+    'adserver.org': '100',
+    'criteo.com': '200',
+    'id5-sync.com': '300',
+    'intentiq.com': '400',
+    'liveintent.com': '500',
+    'quantcast.com': '600',
+    'verizonmedia.com': '700',
+    'liveramp.com': '800'
+  };
+
+  const USER_ID_DATA = {
+    criteoId: SUPPORTED_USER_ID_SOURCES['criteo.com'],
+    vmuid: SUPPORTED_USER_ID_SOURCES['verizonmedia.com'],
+    idl_env: SUPPORTED_USER_ID_SOURCES['liveramp.com'],
+    lipb: {
+      lipbid: SUPPORTED_USER_ID_SOURCES['liveintent.com'],
+      segments: ['100', '200']
+    },
+    tdid: SUPPORTED_USER_ID_SOURCES['adserver.org'],
+    id5id: {
+      uid: SUPPORTED_USER_ID_SOURCES['id5-sync.com'],
+      ext: {foo: 'bar'}
+    },
+    intentIqId: SUPPORTED_USER_ID_SOURCES['intentiq.com'],
+    quantcastId: SUPPORTED_USER_ID_SOURCES['quantcast.com']
+  };
 
   function createCustomBidRequest({bids, params} = {}) {
     var bidderRequest = getDefaultBidRequest();
@@ -463,6 +490,18 @@ describe('AolAdapter', function () {
           '&param1=val1&param2=val2&param3=val3&param4=val4');
       });
 
+      for (const [source, idValue] of Object.entries(SUPPORTED_USER_ID_SOURCES)) {
+        it(`should set the user ID query param for ${source}`, function () {
+          let bidRequest = createCustomBidRequest({
+            params: getNexageGetBidParams()
+          });
+          bidRequest.bids[0].userId = {};
+          bidRequest.bids[0].userIdAsEids = createEidsArray(USER_ID_DATA);
+          let [request] = spec.buildRequests(bidRequest.bids);
+          expect(request.url).to.contain(`&eid${source}=${encodeURIComponent(idValue)}`);
+        });
+      }
+
       it('should return request object for One Mobile POST endpoint when POST configuration is present', function () {
         let bidConfig = getNexagePostBidParams();
         let bidRequest = createCustomBidRequest({
@@ -581,6 +620,22 @@ describe('AolAdapter', function () {
         }
       });
     });
+
+    it('returns the bid object with eid array populated with PB set eids', () => {
+      let userIdBid = Object.assign({
+        userId: {}
+      }, bid);
+      userIdBid.userIdAsEids = createEidsArray(USER_ID_DATA);
+      expect(spec.buildOpenRtbRequestData(userIdBid)).to.deep.equal({
+        id: 'bid-id',
+        imp: [],
+        user: {
+          ext: {
+            eids: userIdBid.userIdAsEids
+          }
+        }
+      });
+    });
   });
 
   describe('getUserSyncs()', function () {