Conversant adapter: use ortbConverter to handle requests and responses

.eslintrc.js

@@ -11,12 +11,25 @@ module.exports = {
       node: {
         moduleDirectory: ['node_modules', './']
       }
+    },
+    'jsdoc': {
+      mode: 'typescript',
+      tagNamePreference: {
+        'tag constructor': 'constructor',
+        extends: 'extends',
+        method: 'method',
+        return: 'return',
+      }
     }
   },
-  extends: 'standard',
+  extends: [
+    'standard',
+    'plugin:jsdoc/recommended'
+  ],
   plugins: [
     'prebid',
-    'import'
+    'import',
+    'jsdoc'
   ],
   globals: {
     'BROWSERSTACK_USERNAME': false,
@@ -46,6 +59,24 @@ module.exports = {
     'no-undef': 2,
     'no-useless-escape': 'off',
     'no-console': 'error',
+    'jsdoc/check-types': 'off',
+    'jsdoc/newline-after-description': 'off',
+    'jsdoc/require-jsdoc': 'off',
+    'jsdoc/require-param': 'off',
+    'jsdoc/require-param-description': 'off',
+    'jsdoc/require-param-name': 'off',
+    'jsdoc/require-param-type': 'off',
+    'jsdoc/require-property': 'off',
+    'jsdoc/require-property-description': 'off',
+    'jsdoc/require-property-name': 'off',
+    'jsdoc/require-property-type': 'off',
+    'jsdoc/require-returns': 'off',
+    'jsdoc/require-returns-check': 'off',
+    'jsdoc/require-returns-description': 'off',
+    'jsdoc/require-returns-type': 'off',
+    'jsdoc/require-yields': 'off',
+    'jsdoc/require-yields-check': 'off',
+    'jsdoc/tag-lines': 'off'
   },
   overrides: Object.keys(allowedModules).map((key) => ({
     files: key + '/**/*.js',

.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],
@@ -42,7 +48,7 @@ const enc = window.encodeURIComponent;
 
 /**
 /* BEGIN ADAGIO.JS CODE
-*/
+ */
 
 function canAccessTopWindow() {
   try {
@@ -65,16 +71,17 @@ const adagioEnqueue = function adagioEnqueue(action, data) {
 };
 
 /**
-* END ADAGIO.JS CODE
-*/
+ * END ADAGIO.JS CODE
+ */
 
 /**
-* UTILS FUNCTIONS
-*/
+ * UTILS FUNCTIONS
+ */
 
 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,10 +116,23 @@ 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
-*/
+ * sendRequest to Adagio. It filter null values and encode each query param.
+ * @param {Object} qp
+ */
 function sendRequest(qp) {
   // Removing null values
   qp = Object.keys(qp).reduce((acc, key) => {
@@ -140,17 +164,18 @@ function getTargetedAuctionId(bid) {
 
 /**
  * END UTILS FUNCTIONS
-*/
+ */
 
 /**
  * HANDLERS
  * - handlerAuctionInit
  * - handlerBidResponse
+ * - handlerAuctionEnd
  * - handlerBidWon
  * - handlerAdRender
  *
  * Each handler is called when the event is fired.
-*/
+ */
 
 function handlerAuctionInit(event) {
   const w = getCurrentWindow();
@@ -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(','),
@@ -247,7 +271,7 @@ function handlerAuctionInit(event) {
  * handlerBidResponse allow to track the adagio bid response
  * and to update the auction cache with the seat ID.
  * No beacon is sent here.
-*/
+ */
 function handlerBidResponse(event) {
   if (!guard.adagio(event.bidder)) {
     return;
@@ -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);
 
@@ -326,7 +372,7 @@ function handlerAdRender(event, isSuccess) {
 
 /**
  * END HANDLERS
-*/
+ */
 
 let adagioAdapter = Object.assign(adapter({ emptyUrl, analyticsType }), {
   track: function(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;