prebid.js 9.52.0 → 9.53.2

package/modules/relevatehealthBidAdapter.js

@@ -1,4 +1,3 @@
-import { formatResponse } from '../libraries/deepintentUtils/index.js';
 import {
   registerBidder
 } from '../src/adapters/bidderFactory.js';
@@ -6,139 +5,30 @@ import {
   BANNER
 } from '../src/mediaTypes.js';
 import {
-  deepAccess,
-  generateUUID,
-  isArray,
-  logError
-} from '../src/utils.js';
-const BIDDER_CODE = 'relevatehealth';
+  getBannerRequest,
+  getBannerResponse
+} from '../libraries/audUtils/bidderUtils.js';
+
+const BCODE = 'relevatehealth';
 const ENDPOINT_URL = 'https://rtb.relevate.health/prebid/relevate';
 
-function buildRequests(bidRequests, bidderRequest) {
-  const requests = [];
-  // Loop through each bid request
-  bidRequests.forEach(bid => {
-    // Construct the bid request object
-    const request = {
-      id: generateUUID(),
-      placementId: bid.params.placement_id,
-      imp: [{
-        id: bid.bidId,
-        banner: getBanner(bid),
-        bidfloor: getFloor(bid)
-      }],
-      site: getSite(bidderRequest),
-      user: buildUser(bid)
-    };
-    // Get uspConsent from bidderRequest
-    if (bidderRequest && bidderRequest.uspConsent) {
-      request.us_privacy = bidderRequest.uspConsent;
-    }
-    // Get GPP Consent from bidderRequest
-    if (bidderRequest?.gppConsent?.gppString) {
-      request.gpp = bidderRequest.gppConsent.gppString;
-      request.gpp_sid = bidderRequest.gppConsent.applicableSections;
-    } else if (bidderRequest?.ortb2?.regs?.gpp) {
-      request.gpp = bidderRequest.ortb2.regs.gpp;
-      request.gpp_sid = bidderRequest.ortb2.regs.gpp_sid;
-    }
-    // Get coppa compliance from bidderRequest
-    if (bidderRequest?.ortb2?.regs?.coppa) {
-      request.coppa = 1;
-    }
-    // Push the constructed bid request to the requests array
-    requests.push(request);
-  });
-  // Return the array of bid requests
-  return {
-    method: 'POST',
-    url: ENDPOINT_URL,
-    data: JSON.stringify(requests),
-    options: {
-      contentType: 'application/json',
-    }
-  };
-}
-// Format the response as per the standards
-function interpretResponse(bidResponse, bidRequest) {
-  let resp = [];
-  if (bidResponse && bidResponse.body) {
-    try {
-      let bids = bidResponse.body.seatbid && bidResponse.body.seatbid[0] ? bidResponse.body.seatbid[0].bid : [];
-      if (bids) {
-        bids.forEach(bidObj => {
-          let newBid = formatResponse(bidObj);
-          newBid.mediaType = BANNER;
-          resp.push(newBid);
-        });
-      }
-    } catch (err) {
-      logError(err);
-    }
-  }
-  return resp;
-}
-// Function to check if Bid is valid
-function isBidRequestValid(bid) {
-  return !!(bid.params.placement_id && bid.params.user_id);
-}
-// Function to get banner details
-function getBanner(bid) {
-  if (deepAccess(bid, 'mediaTypes.banner')) {
-    // Fetch width and height from MediaTypes object, if not provided in bid params
-    if (deepAccess(bid, 'mediaTypes.banner.sizes') && !bid.params.height && !bid.params.width) {
-      let sizes = deepAccess(bid, 'mediaTypes.banner.sizes');
-      if (isArray(sizes) && sizes.length > 0) {
-        return {
-          h: sizes[0][1],
-          w: sizes[0][0]
-        };
-      }
-    } else {
-      return {
-        h: bid.params.height,
-        w: bid.params.width
-      };
-    }
-  }
-}
-// Function to get bid_floor
-function getFloor(bid) {
-  if (bid.params && bid.params.bid_floor) {
-    return bid.params.bid_floor;
-  } else {
-    return 0;
-  }
-}
-// Function to get site details
-function getSite(bidderRequest) {
-  let site = {};
-  if (bidderRequest && bidderRequest.refererInfo && bidderRequest.refererInfo.page) {
-    site.name = bidderRequest.refererInfo.domain;
-  } else {
-    site.name = '';
-  }
-  return site;
-}
-// Function to build the user object
-function buildUser(bid) {
-  if (bid && bid.params) {
-    return {
-      id: bid.params.user_id && typeof bid.params.user_id == 'string' ? bid.params.user_id : '',
-      // TODO: commented out because of rule violations
-      buyeruid: '', // localStorage.getItem('adx_profile_guid') ? localStorage.getItem('adx_profile_guid') : '',
-      keywords: bid.params.keywords && typeof bid.params.keywords == 'string' ? bid.params.keywords : '',
-      customdata: bid.params.customdata && typeof bid.params.customdata == 'string' ? bid.params.customdata : ''
-    };
-  }
-}
-// Export const spec
 export const spec = {
-  code: BIDDER_CODE,
+  code: BCODE,
   supportedMediaTypes: BANNER,
-  isBidRequestValid,
-  buildRequests,
-  interpretResponse
+  // Determines whether given bid request is valid or not
+  isBidRequestValid: (bidReqParam) => {
+    return !!(bidReqParam.params.placement_id);
+  },
+  // Make a server request from the list of BidRequests
+  buildRequests: (bidReq, serverReq) => {
+    // Get Requests based on media types
+    return getBannerRequest(bidReq, serverReq, ENDPOINT_URL);
+  },
+  // Unpack the response from the server into a list of bids.
+  interpretResponse: (bidResp, bidReq) => {
+    const Response = getBannerResponse(bidResp, BANNER);
+    return Response;
+  }
 }
 
 registerBidder(spec);

package/modules/relevatehealthBidAdapter.md

@@ -27,11 +27,10 @@ Module that connects to relevatehealth's demand sources.
             bidder: 'relevatehealth',
             params: {
                 placement_id: 110011,  // Required parameter
-                user_id: '1111111' // Required parameter
                 width: 160,   // Optional parameter 
                 height: 600, // Optional parameter
                 domain: '', // Optional parameter
-		        bid_floor: 0.5 // Optional parameter
+		            bid_floor: 0.5 // Optional parameter
             }
         }
       ]

package/modules/sovrnBidAdapter.js

@@ -234,15 +234,15 @@ export const spec = {
             dealId: sovrnBid.dealid || null,
             currency: 'USD',
             netRevenue: true,
-            mediaType: sovrnBid.nurl ? BANNER : VIDEO,
+            mediaType: sovrnBid.mtype == 2 ? VIDEO : BANNER,
             ttl: sovrnBid.ext?.ttl || 90,
             meta: { advertiserDomains: sovrnBid && sovrnBid.adomain ? sovrnBid.adomain : [] }
           }
 
-          if (sovrnBid.nurl) {
-            bid.ad = decodeURIComponent(`${sovrnBid.adm}<img src="${sovrnBid.nurl}">`)
-          } else {
+          if (sovrnBid.mtype == 2) {
             bid.vastXml = decodeURIComponent(sovrnBid.adm)
+          } else {
+            bid.ad = sovrnBid.nurl ? decodeURIComponent(`${sovrnBid.adm}<img src="${sovrnBid.nurl}">`) : decodeURIComponent(sovrnBid.adm)
           }
 
           return bid

package/modules/teadsBidAdapter.js

@@ -80,6 +80,7 @@ export const spec = {
       hardwareConcurrency: getHC(),
       deviceMemory: getDM(),
       hb_version: '$prebid.version$',
+      eids: getUserIdAsEids(validBidRequests),
       ...getSharedViewerIdParameters(validBidRequests),
       outbrainId: storage.getDataFromLocalStorage(OB_USER_TOKEN_KEY),
       ...getFirstPartyTeadsIdParameter(validBidRequests)
@@ -215,6 +216,10 @@ function getSharedViewerIdParameters(validBidRequests) {
   return sharedViewerIdObject;
 }
 
+function getUserIdAsEids(validBidRequests) {
+  return validBidRequests?.[0]?.userIdAsEids || [];
+}
+
 function getReferrerInfo(bidderRequest) {
   let ref = '';
   if (bidderRequest && bidderRequest.refererInfo && bidderRequest.refererInfo.page) {

package/modules/ttdBidAdapter.js

@@ -107,13 +107,14 @@ function getUser(bidderRequest, firstPartyData) {
     utils.deepSetValue(user, 'ext.consent', bidderRequest.gdprConsent.consentString);
   }
 
-  if (utils.isStr(utils.deepAccess(bidderRequest, 'bids.0.userId.tdid'))) {
-    user.buyeruid = bidderRequest.bids[0].userId.tdid;
-  }
-
   var eids = utils.deepAccess(bidderRequest, 'bids.0.userIdAsEids')
   if (eids && eids.length) {
     utils.deepSetValue(user, 'ext.eids', eids);
+
+    const tdid = eids.find(eid => eid.source == 'adserver.org')?.uids?.[0]?.id;
+    if (tdid) {
+      user.buyeruid = tdid
+    }
   }
 
   utils.mergeDeep(user, firstPartyData.user)

package/modules/userId/index.js

@@ -571,25 +571,21 @@ export function enrichEids(ortb2Fragments) {
 export function addIdData({adUnits, ortb2Fragments}) {
   ortb2Fragments = ortb2Fragments ?? {global: {}, bidder: {}}
   enrichEids(ortb2Fragments);
-  if ([adUnits].some(i => !Array.isArray(i) || !i.length)) {
-    return;
+
+  // Set bid.userId for backward compatibility with tests
+  if (adUnits && Array.isArray(adUnits) && adUnits.length) {
+    const globalIds = getIds(initializedSubmodules.global);
+    adUnits.forEach(adUnit => {
+      if (adUnit.bids && Array.isArray(adUnit.bids)) {
+        adUnit.bids.forEach(bid => {
+          const bidderIds = Object.assign({}, globalIds, getIds(initializedSubmodules.bidder[bid.bidder] ?? {}));
+          if (Object.keys(bidderIds).length > 0) {
+            bid.userId = bidderIds;
+          }
+        });
+      }
+    });
   }
-  const globalIds = getIds(initializedSubmodules.global);
-  const globalEids = ortb2Fragments.global.user?.ext?.eids || [];
-  adUnits.forEach(adUnit => {
-    if (adUnit.bids && isArray(adUnit.bids)) {
-      adUnit.bids.forEach(bid => {
-        const bidderIds = Object.assign({}, globalIds, getIds(initializedSubmodules.bidder[bid.bidder] ?? {}));
-        const bidderEids = globalEids.concat(ortb2Fragments.bidder?.[bid.bidder]?.user?.ext?.eids || []);
-        if (Object.keys(bidderIds).length > 0) {
-          bid.userId = bidderIds;
-        }
-        if (bidderEids.length > 0) {
-          bid.userIdAsEids = bidderEids;
-        }
-      });
-    }
-  });
 }
 
 const INIT_CANCELED = {};
@@ -724,15 +720,22 @@ export const startAuctionHook = timedAuctionHook('userId', function requestBidsH
 });
 
 /**
- * Append user id data from config to bids to be accessed in adapters when there are no submodules.
- * @param {function} fn required; The next function in the chain, used by hook.js
- * @param {Object} reqBidsConfigObj required; This is the same param that's used in pbjs.requestBids.
+ * Alias bid requests' `userIdAsEids` to `ortb2.user.ext.eids`
+ * Do this lazily (instead of attaching a copy) so that it also shows EIDs added after the userId module runs (e.g. from RTD modules)
  */
-export const addUserIdsHook = timedAuctionHook('userId', function requestBidsHook(fn, reqBidsConfigObj) {
-  addIdData(reqBidsConfigObj);
-  // calling fn allows prebid to continue processing
-  fn.call(this, reqBidsConfigObj);
-});
+function aliasEidsHook(next, bidderRequests) {
+  bidderRequests.forEach(bidderRequest => {
+    bidderRequest.bids.forEach(bid =>
+      Object.defineProperty(bid, 'userIdAsEids', {
+        configurable: true,
+        get() {
+          return bidderRequest.ortb2.user?.ext?.eids;
+        }
+      })
+    )
+  })
+  next(bidderRequests);
+}
 
 /**
  * Is startAuctionHook added
@@ -1158,7 +1161,6 @@ function updateSubmodules() {
 
   if (submodules.length) {
     if (!addedStartAuctionHook()) {
-      startAuction.getHooks({hook: addUserIdsHook}).remove();
       startAuction.before(startAuctionHook, 100) // use higher priority than dataController / rtd
       adapterManager.callDataDeletionRequest.before(requestDataDeletion);
       coreGetPPID.after((next) => next(getPPID()));
@@ -1259,6 +1261,7 @@ export function init(config, {mkDelay = delay} = {}) {
       }
     }
   });
+  adapterManager.makeBidRequests.after(aliasEidsHook);
 
   // exposing getUserIds function in global-name-space so that userIds stored in Prebid can be used by external codes.
   (getGlobal()).getUserIds = getUserIds;
@@ -1268,10 +1271,6 @@ export function init(config, {mkDelay = delay} = {}) {
   (getGlobal()).refreshUserIds = normalizePromise(refreshUserIds);
   (getGlobal()).getUserIdsAsync = normalizePromise(getUserIdsAsync);
   (getGlobal()).getUserIdsAsEidBySource = getUserIdsAsEidBySource;
-  if (!addedStartAuctionHook()) {
-    // Add ortb2.user.ext.eids even if 0 submodules are added
-    startAuction.before(addUserIdsHook, 100); // use higher priority than dataController / rtd
-  }
 }
 
 export function resetUserIds() {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "prebid.js",
-  "version": "9.52.0",
+  "version": "9.53.2",
   "description": "Header Bidding Management Library",
   "main": "src/prebid.public.js",
   "exports": {
@@ -100,6 +100,7 @@
     "karma-sourcemap-loader": "^0.3.7",
     "karma-spec-reporter": "^0.0.32",
     "karma-webpack": "^5.0.0",
+    "lcov-result-merger": "^5.0.1",
     "lodash": "^4.17.21",
     "mocha": "^10.7.3",
     "morgan": "^1.10.0",
@@ -122,8 +123,7 @@
     "webpack": "^5.70.0",
     "webpack-bundle-analyzer": "^4.5.0",
     "webpack-manifest-plugin": "^5.0.0",
-    "webpack-stream": "^7.0.0",
-    "yargs": "^1.3.1"
+    "webpack-stream": "^7.0.0"
   },
   "dependencies": {
     "@babel/core": "^7.27.4",
@@ -138,7 +138,8 @@
     "fun-hooks": "^1.1.0",
     "gulp-wrap": "^0.15.0",
     "klona": "^2.0.6",
-    "live-connect-js": "^7.2.0"
+    "live-connect-js": "^7.2.0",
+    "yargs": "^1.3.1"
   },
   "optionalDependencies": {
     "fsevents": "^2.3.2"

package/src/adapterManager.js

@@ -207,6 +207,9 @@ function getAdUnitCopyForPrebidServer(adUnits, s2sConfig) {
 
   // don't send empty requests
   adUnitsCopy = adUnitsCopy.filter(adUnit => {
+    if (s2sConfig.filterBidderlessCalls) {
+      if (adUnit.bids.length === 1 && adUnit.bids[0].bidder == null) return false;
+    }
     return adUnit.bids.length !== 0 || adUnit.s2sBid != null;
   });
   return {adUnits: adUnitsCopy, hasModuleBids};

package/test/spec/libraries/cmUtils_spec.js

@@ -2,13 +2,15 @@ import * as utils from 'src/utils.js';
 import {lookupConsentData, consentManagementHook} from '../../../libraries/consentManagement/cmUtils';
 
 describe('consent management utils', () => {
-  let sandbox;
+  let sandbox, clock;
   beforeEach(() => {
     sandbox = sinon.createSandbox();
+    clock = sandbox.useFakeTimers();
     ['logError', 'logInfo', 'logWarn'].forEach(n => sandbox.stub(utils, n));
   });
   afterEach(() => {
     sandbox.restore();
+    clock.restore();
   });
 
   describe('consentManagementHook', () => {
@@ -168,7 +170,7 @@ describe('consent management utils', () => {
 
         it('should not time out after it resolves', async () => {
           await runLookup();
-          await new Promise((resolve) => setTimeout(resolve, timeout + 10));
+          clock.tick(timeout + 10);
           sinon.assert.notCalled(consentDataHandler.setConsentData);
         });
       });
@@ -187,7 +189,9 @@ describe('consent management utils', () => {
       [0, 100].forEach(timeout => {
         it(`should resolve with null consent after cmpTimeout ( = ${timeout}ms)`, async () => {
           cmpTimeout = timeout;
-          const {consentData, error} = await runLookup();
+          const lookup = runLookup();
+          clock.tick(timeout + 1);
+          const {consentData, error} = await lookup;
           sinon.assert.calledWith(consentDataHandler.setConsentData, {consent: null});
           expect(consentData).to.eql({consent: null})
           expect(error.message).to.match(/.*CMP to load.*/)
@@ -198,26 +202,27 @@ describe('consent management utils', () => {
           cmpTimeout = 100;
           actionTimeout = timeout;
           const lookup = runLookup();
-          await new Promise((resolve) => setTimeout(resolve, 10));
+          clock.tick(10);
           setProvisionalConsent({consent: 'provisional'});
+          clock.tick(timeout + 1);
           const {consentData, error} = await lookup;
           expect(consentData).to.eql({consent: 'provisional'});
           expect(error.message).to.match(/.*action.*/)
         });
       });
 
-      it('should not reset action timeout if provisional consent is updated multiple times', (done) => {
+      it('should not reset action timeout if provisional consent is updated multiple times', async () => {
         actionTimeout = 100;
         let consentData;
-        runLookup().then((res) => {
+        const lookup = runLookup().then((res) => {
           consentData = res.consentData;
-        })
+        });
         setProvisionalConsent({consent: 1});
-        setTimeout(() => setProvisionalConsent({consent: 2}), 20);
-        setTimeout(() => {
-          expect(consentData).to.eql({consent: 2});
-          done();
-        }, 100)
+        clock.tick(20);
+        setProvisionalConsent({consent: 2});
+        clock.tick(80);
+        await lookup;
+        expect(consentData).to.eql({consent: 2});
       })
     });
   });

package/test/spec/modules/aniviewBidAdapter_spec.js

@@ -222,6 +222,20 @@ describe('Aniview Bid Adapter', function () {
       expect(imp.bidfloorcur).not.exist;
     });
 
+    it('should have vastUrl if adm is not provided but nurl is', function () {
+      const bidRequests = spec.buildRequests(videoBidRequest.bids, videoBidRequest);
+      const bidderResponse = MOCK.bidderResponse();
+
+      delete bidderResponse.body.seatbid[0].bid[0].adm
+
+      const bids = spec.interpretResponse(bidderResponse, bidRequests[0]);
+      const bid = bids[0];
+
+      expect(bid.vastXml).to.not.exist;
+      expect(bid.vastUrl).to.exist.and.to.not.have.string('${AUCTION_PRICE}');
+      expect(bid.vastUrl).to.have.string('cpm=' + PRICE);
+    });
+
     it('should use dev environment', function () {
       const DEV_ENDPOINT = 'https://dev.aniview.com/sspRTB2';
       videoBidRequest.bids[0].params.dev = { endpoint: DEV_ENDPOINT };
@@ -257,8 +271,7 @@ describe('Aniview Bid Adapter', function () {
         expect(bids.length).to.greaterThan(0);
         expect(bid.vastXml).to.exist.and.to.not.have.string('${AUCTION_PRICE}');
         expect(bid.vastXml).to.have.string('cpm=' + PRICE);
-        expect(bid.vastUrl).to.exist.and.to.not.have.string('${AUCTION_PRICE}');
-        expect(bid.vastUrl).to.have.string('cpm=' + PRICE);
+        expect(bid.vastUrl).to.not.exist;
         expect(bid.requestId).to.equal(bidRequests[0].data.imp[0].id);
         expect(bid.cpm).to.equal(PRICE);
         expect(bid.ttl).to.equal(TTL);