PFG-2579: prebid update to latest 8.30.0

.github/workflows/codeql-analysis.yml

@@ -42,7 +42,7 @@ jobs:
 
     # Initializes the CodeQL tools for scanning.
     - name: Initialize CodeQL
-      uses: github/codeql-action/init@v2
+      uses: github/codeql-action/init@v3
       with:
         languages: ${{ matrix.language }}
         config-file: ./.github/codeql/codeql-config.yml
@@ -57,7 +57,7 @@ jobs:
     # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
     # If this step fails, then you should remove it and run the build manually (see below)
     - name: Autobuild
-      uses: github/codeql-action/autobuild@v2
+      uses: github/codeql-action/autobuild@v3
 
     # ℹ️ Command-line programs to run using the OS shell.
     # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
@@ -70,4 +70,4 @@ jobs:
     #   ./location_of_script_within_repo/buildscript.sh
 
     - name: Perform CodeQL Analysis
-      uses: github/codeql-action/analyze@v2
+      uses: github/codeql-action/analyze@v3

libraries/ortbConverter/README.md

@@ -80,8 +80,7 @@ However, there are two restrictions (to avoid them, use the [other customization
     )   
     ```
 
-<a id="fine-customization" />
-### Fine grained customization - imp, request, bidResponse, response
+### <a id="fine-customization" /> Fine grained customization - imp, request, bidResponse, response
 
 When invoked, `toORTB({bidRequests, bidderRequest})` first loops through each request in `bidRequests`, converting them into ORTB `imp` objects.
 It then packages them into a single ORTB request, adding other parameters that are not imp-specific (such as for example `request.tmax`).
@@ -91,7 +90,7 @@ a single return value.
 
 You can customize each of these steps using the `ortbConverter` arguments `imp`, `request`, `bidResponse` and `response`:
 
-### <a id="imp" />Customizing imps: `imp(buildImp, bidRequest, context)`
+### <a id="imp" /> Customizing imps: `imp(buildImp, bidRequest, context)`
 
 Invoked once for each input `bidRequest`; should return the ORTB `imp` object to include in the request.
 The arguments are:
@@ -101,7 +100,7 @@ The arguments are:
 - `context`: a [context object](#context) that contains at least:
    - `bidderRequest`: the `bidderRequest` argument passed to `toORTB`.
 
-#### <a id="params" />Example: attaching custom bid params
+#### <a id="params" /> Example: attaching custom bid params
 
 ```javascript
 const converter = ortbConverter({
@@ -351,7 +350,7 @@ const converter = ortbConverter({
 - the `context` argument of `ortbConverter`: e.g. `ortbConverter({context: {ttl: 30}})`. This will set `context.ttl = 30` globally for the converter.
 - the `context` argument of `toORTB`: e.g. `converter.toORTB({bidRequests, bidderRequest, context: {ttl: 30}})`. This will set `context.ttl = 30` only for this request.
 
-### <a id="special-context"/> Special `context` properties
+### <a id="special-context" /> Special `context` properties
 
 For ease of use, the conversion logic gives special meaning to some context properties:
 

modules/.submodules.json

@@ -47,7 +47,8 @@
       "adqueryIdSystem",
       "gravitoIdSystem",
       "freepassIdSystem",
-      "operaadsIdSystem"
+      "operaadsIdSystem",
+      "mygaruIdSystem"
     ],
     "adpod": [
       "freeWheelAdserverVideo",

modules/adagioAnalyticsAdapter.js

@@ -22,6 +22,12 @@ const cache = {
   getAuction: function(auctionId, adUnitCode) {
     return this.auctions[auctionId][adUnitCode];
   },
+  getBiddersFromAuction: function(auctionId, adUnitCode) {
+    return this.getAuction(auctionId, adUnitCode).bdrs.split(',');
+  },
+  getAllAdUnitCodes: function(auctionId) {
+    return Object.keys(this.auctions[auctionId]);
+  },
   updateAuction: function(auctionId, adUnitCode, values) {
     this.auctions[auctionId][adUnitCode] = {
       ...this.auctions[auctionId][adUnitCode],
@@ -74,7 +80,8 @@ const adagioEnqueue = function adagioEnqueue(action, data) {
 
 const guard = {
   adagio: (value) => isAdagio(value),
-  bidTracked: (auctionId, adUnitCode) => deepAccess(cache, `auctions.${auctionId}.${adUnitCode}`, false)
+  bidTracked: (auctionId, adUnitCode) => deepAccess(cache, `auctions.${auctionId}.${adUnitCode}`, false),
+  auctionTracked: (auctionId) => deepAccess(cache, `auctions.${auctionId}`, false)
 };
 
 function removeDuplicates(arr, getKey) {
@@ -90,6 +97,10 @@ function getAdapterNameForAlias(aliasName) {
 };
 
 function isAdagio(value) {
+  if (!value) {
+    return false
+  }
+
   return value.toLowerCase().includes('adagio') ||
     getAdapterNameForAlias(value).toLowerCase().includes('adagio');
 };
@@ -105,6 +116,19 @@ function getMediaTypeAlias(mediaType) {
   return mediaTypesMap[mediaType] || mediaType;
 };
 
+function addKeyPrefix(obj, prefix) {
+  return Object.keys(obj).reduce((acc, key) => {
+    // We don't want to prefix already prefixed keys.
+    if (key.startsWith(prefix)) {
+      acc[key] = obj[key];
+      return acc;
+    }
+
+    acc[`${prefix}${key}`] = obj[key];
+    return acc;
+  }, {});
+}
+
 /**
 * sendRequest to Adagio. It filter null values and encode each query param.
 * @param {Object} qp
@@ -146,6 +170,7 @@ function getTargetedAuctionId(bid) {
  * HANDLERS
  * - handlerAuctionInit
  * - handlerBidResponse
+ * - handlerAuctionEnd
  * - handlerBidWon
  * - handlerAdRender
  *
@@ -227,11 +252,10 @@ function handlerAuctionInit(event) {
       auct_id: adagioAuctionId,
       adu_code: adUnitCode,
       url_dmn: w.location.hostname,
-      dvc: params.environment,
       pgtyp: params.pagetype,
       plcmt: params.placement,
-      tname: params.testName || null,
-      tvname: params.testVariationName || null,
+      t_n: params.testName || null,
+      t_v: params.testVersion || null,
       mts: mediaTypesKeys.join(','),
       ban_szs: bannerSizes.join(','),
       bdrs: bidders.map(bidder => getAdapterNameForAlias(bidder.bidder)).sort().join(','),
@@ -257,11 +281,33 @@ function handlerBidResponse(event) {
     return;
   }
 
+  if (!event.pba) {
+    return;
+  }
+
   cache.updateAuction(event.auctionId, event.adUnitCode, {
-    adg_sid: event.seatId || null
+    ...addKeyPrefix(event.pba, 'e_')
   });
 };
 
+function handlerAuctionEnd(event) {
+  const { auctionId } = event;
+
+  if (!guard.auctionTracked(auctionId)) {
+    return;
+  }
+
+  const adUnitCodes = cache.getAllAdUnitCodes(auctionId);
+  adUnitCodes.forEach(adUnitCode => {
+    const mapper = (bidder) => event.bidsReceived.find(bid => bid.adUnitCode === adUnitCode && bid.bidder === bidder) ? '1' : '0';
+
+    cache.updateAuction(auctionId, adUnitCode, {
+      bdrs_bid: cache.getBiddersFromAuction(auctionId, adUnitCode).map(mapper).join(',')
+    });
+    sendNewBeacon(auctionId, adUnitCode);
+  });
+}
+
 function handlerBidWon(event) {
   let auctionId = getTargetedAuctionId(event);
 
@@ -340,10 +386,14 @@ let adagioAdapter = Object.assign(adapter({ emptyUrl, analyticsType }), {
         case CONSTANTS.EVENTS.BID_RESPONSE:
           handlerBidResponse(args);
           break;
+        case CONSTANTS.EVENTS.AUCTION_END:
+          handlerAuctionEnd(args);
+          break;
         case CONSTANTS.EVENTS.BID_WON:
           handlerBidWon(args);
           break;
-        case CONSTANTS.EVENTS.AD_RENDER_SUCCEEDED:
+        // AD_RENDER_SUCCEEDED seems redundant with BID_WON.
+        // case CONSTANTS.EVENTS.AD_RENDER_SUCCEEDED:
         case CONSTANTS.EVENTS.AD_RENDER_FAILED:
           handlerAdRender(args, eventType === CONSTANTS.EVENTS.AD_RENDER_SUCCEEDED);
           break;

modules/admaticBidAdapter.js

@@ -1,4 +1,4 @@
-import {getValue, logError, isEmpty, deepAccess, isArray, getBidIdParameter} from '../src/utils.js';
+import {getValue, formatQS, logError, deepAccess, isArray, getBidIdParameter} from '../src/utils.js';
 import { registerBidder } from '../src/adapters/bidderFactory.js';
 import { config } from '../src/config.js';
 import { BANNER, VIDEO, NATIVE } from '../src/mediaTypes.js';
@@ -56,18 +56,16 @@ export const spec = {
    * @return {ServerRequest}
    */
   buildRequests: (validBidRequests, bidderRequest) => {
+    const tmax = bidderRequest.timeout;
     const bids = validBidRequests.map(buildRequestObject);
-    const blacklist = bidderRequest.ortb2;
+    const ortb = bidderRequest.ortb2;
     const networkId = getValue(validBidRequests[0].params, 'networkId');
     const host = getValue(validBidRequests[0].params, 'host');
     const currency = config.getConfig('currency.adServerCurrency') || 'TRY';
     const bidderName = validBidRequests[0].bidder;
 
     const payload = {
-      user: {
-        ua: navigator.userAgent
-      },
-      blacklist: [],
+      ortb,
       site: {
         page: bidderRequest.refererInfo.page,
         ref: bidderRequest.refererInfo.page,
@@ -80,17 +78,59 @@ export const spec = {
       ext: {
         cur: currency,
         bidder: bidderName
-      }
+      },
+      schain: {},
+      regs: {
+        ext: {
+        }
+      },
+      user: {
+        ext: {}
+      },
+      at: 1,
+      tmax: parseInt(tmax)
     };
 
-    if (!isEmpty(blacklist.badv)) {
-      payload.blacklist = blacklist.badv;
-    };
+    if (bidderRequest && bidderRequest.gdprConsent && bidderRequest.gdprConsent.gdprApplies) {
+      const consentStr = (bidderRequest.gdprConsent.consentString)
+        ? bidderRequest.gdprConsent.consentString.replace(/\+/g, '-').replace(/\//g, '_').replace(/=+$/, '') : '';
+      const gdpr = bidderRequest.gdprConsent.gdprApplies ? 1 : 0;
+      payload.regs.ext.gdpr = gdpr;
+      payload.regs.ext.consent = consentStr;
+    }
+
+    if (bidderRequest && bidderRequest.coppa) {
+      payload.regs.ext.coppa = bidderRequest.coppa === true ? 1 : (bidderRequest.coppa === false ? 0 : undefined);
+    }
+
+    if (bidderRequest && bidderRequest.ortb2?.regs?.gpp) {
+      payload.regs.ext.gpp = bidderRequest.ortb2?.regs?.gpp;
+    }
+
+    if (bidderRequest && bidderRequest.ortb2?.regs?.gpp_sid) {
+      payload.regs.ext.gpp_sid = bidderRequest.ortb2?.regs?.gpp_sid;
+    }
+
+    if (bidderRequest && bidderRequest.uspConsent) {
+      payload.regs.ext.uspIab = bidderRequest.uspConsent;
+    }
+
+    if (validBidRequests[0].schain) {
+      const schain = mapSchain(validBidRequests[0].schain);
+      if (schain) {
+        payload.schain = schain;
+      }
+    }
+
+    if (validBidRequests[0].userIdAsEids) {
+      const eids = { eids: validBidRequests[0].userIdAsEids };
+      payload.user.ext = { ...payload.user.ext, ...eids };
+    }
 
     if (payload) {
       switch (bidderName) {
         case 'pixad':
-          SYNC_URL = 'https://static.pixad.com.tr/sync.html';
+          SYNC_URL = 'https://static.cdn.pixad.com.tr/sync.html';
           break;
         default:
           SYNC_URL = 'https://cdn.serve.admatic.com.tr/showad/sync.html';
@@ -101,12 +141,36 @@ export const spec = {
     }
   },
 
-  getUserSyncs: function (syncOptions, responses) {
-    if (syncOptions.iframeEnabled) {
-      return [{
+  getUserSyncs: function (syncOptions, responses, gdprConsent, uspConsent, gppConsent) {
+    if (!hasSynced && syncOptions.iframeEnabled) {
+      // data is only assigned if params are available to pass to syncEndpoint
+      let params = {};
+
+      if (gdprConsent) {
+        if (typeof gdprConsent.gdprApplies === 'boolean') {
+          params['gdpr'] = Number(gdprConsent.gdprApplies);
+        }
+        if (typeof gdprConsent.consentString === 'string') {
+          params['gdpr_consent'] = gdprConsent.consentString;
+        }
+      }
+
+      if (uspConsent) {
+        params['us_privacy'] = encodeURIComponent(uspConsent);
+      }
+
+      if (gppConsent?.gppString) {
+        params['gpp'] = gppConsent.gppString;
+        params['gpp_sid'] = gppConsent.applicableSections?.toString();
+      }
+
+      params = Object.keys(params).length ? `?${formatQS(params)}` : '';
+
+      hasSynced = true;
+      return {
         type: 'iframe',
-        url: SYNC_URL
-      }];
+        url: SYNC_URL + params
+      };
     }
   },
 
@@ -156,6 +220,41 @@ export const spec = {
   }
 };
 
+var hasSynced = false;
+
+export function resetUserSync() {
+  hasSynced = false;
+}
+
+/**
+ * @param {object} schain object set by Publisher
+ * @returns {object} OpenRTB SupplyChain object
+ */
+function mapSchain(schain) {
+  if (!schain) {
+    return null;
+  }
+  if (!validateSchain(schain)) {
+    logError('AdMatic: required schain params missing');
+    return null;
+  }
+  return schain;
+}
+
+/**
+ * @param {object} schain object set by Publisher
+ * @returns {object} bool
+ */
+function validateSchain(schain) {
+  if (!schain.nodes) {
+    return false;
+  }
+  const requiredFields = ['asi', 'sid', 'hp'];
+  return schain.nodes.every(node => {
+    return requiredFields.every(field => node[field]);
+  });
+}
+
 function isUrl(str) {
   try {
     URL(str);