AMX Bid Adapter: add gpp support (prebid#9556)

* AMX bid adapter: add gpp support, cookie sync improvements

* fix unit tests

Author: nickjacob

modules/amxBidAdapter.js

@@ -9,6 +9,7 @@ import {
   triggerPixel,
   isFn,
   logError,
+  isArray,
 } from '../src/utils.js';
 import { config } from '../src/config.js';
 import { getStorageManager } from '../src/storageManager.js';
@@ -192,6 +193,51 @@ function resolveSize(bid, request, bidId) {
   return [bidRequest.aw, bidRequest.ah];
 }
 
+function isSyncEnabled(syncConfigP, syncType) {
+  const syncConfig = syncConfigP[syncType];
+  if (syncConfig == null) {
+    return false;
+  }
+
+  if (syncConfig.bidders === '*' || (isArray(syncConfig.bidders) && syncConfig.bidders.indexOf('amx') !== -1)) {
+    return syncConfig.filter == null || syncConfig.filter === 'include';
+  }
+
+  return false;
+}
+
+const SYNC_IMAGE = 1;
+const SYNC_IFRAME = 2;
+
+function getSyncSettings() {
+  const syncConfig = config.getConfig('userSync');
+  if (syncConfig == null) {
+    return {
+      d: 0,
+      l: 0,
+      t: 0,
+      e: true
+    };
+  }
+
+  const settings = { d: syncConfig.syncDelay, l: syncConfig.syncsPerBidder, t: 0, e: syncConfig.syncEnabled }
+  const all = isSyncEnabled(syncConfig.filterSettings, 'all')
+
+  if (all) {
+    settings.t = SYNC_IMAGE & SYNC_IFRAME;
+    return settings;
+  }
+
+  if (isSyncEnabled(syncConfig.filterSettings, 'iframe')) {
+    settings.t |= SYNC_IFRAME;
+  }
+  if (isSyncEnabled(syncConfig.filterSettings, 'image')) {
+    settings.t |= SYNC_IMAGE;
+  }
+
+  return settings;
+}
+
 function values(source) {
   if (Object.values != null) {
     return Object.values(source);
@@ -202,6 +248,30 @@ function values(source) {
   });
 }
 
+function getGpp(bidderRequest) {
+  if (bidderRequest?.gppConsent != null) {
+    return bidderRequest.gppConsent;
+  }
+
+  return bidderRequest?.ortb2?.regs?.gpp ?? {gppString: '', applicableSections: ''};
+}
+
+function buildReferrerInfo(bidderRequest) {
+  if (bidderRequest.refererInfo == null) {
+    return {r: '', t: false, c: '', l: 0, s: []}
+  }
+
+  const re = bidderRequest.refererInfo;
+
+  return {
+    r: re.topmostLocation,
+    t: re.reachedTop,
+    l: re.numIframes,
+    s: re.stack,
+    c: re.canonicalUrl,
+  }
+}
+
 const isTrue = (boolValue) =>
   boolValue === true || boolValue === 1 || boolValue === 'true';
 
@@ -249,6 +319,7 @@ export const spec = {
       w: screen.width,
       gs: deepAccess(bidderRequest, 'gdprConsent.gdprApplies', ''),
       gc: deepAccess(bidderRequest, 'gdprConsent.consentString', ''),
+      gpp: getGpp(bidderRequest),
       u: refInfo(bidderRequest, 'page', loc.href),
       do: refInfo(bidderRequest, 'site', loc.hostname),
       re: refInfo(bidderRequest, 'ref'),
@@ -261,6 +332,8 @@ export const spec = {
       fpd2: bidderRequest.ortb2,
       tmax: config.getConfig('bidderTimeout'),
       amp: refInfo(bidderRequest, 'isAmp', null),
+      ri: buildReferrerInfo(bidderRequest),
+      sync: getSyncSettings(),
       eids: values(
         bidRequests.reduce((all, bid) => {
           // we only want unique ones in here
@@ -287,17 +360,38 @@ export const spec = {
     };
   },
 
-  getUserSyncs(syncOptions, serverResponses) {
+  getUserSyncs(syncOptions, serverResponses, gdprConsent, uspConsent, gppConsent) {
+    const qp = {
+      gdpr_consent: enc(gdprConsent?.consentString || ''),
+      gdpr: enc(gdprConsent?.gdprApplies ? 1 : 0),
+      us_privacy: enc(uspConsent || ''),
+      gpp: enc(gppConsent?.gppString || ''),
+      gpp_sid: enc(gppConsent?.applicableSections || '')
+    };
+
+    const iframeSync = {
+      url: `https://prebid.a-mo.net/isyn?${formatQS(qp)}`,
+      type: 'iframe'
+    };
+
     if (serverResponses == null || serverResponses.length === 0) {
+      if (syncOptions.iframeEnabled) {
+        return [iframeSync]
+      }
+
       return [];
     }
+
     const output = [];
+    let hasFrame = false;
+
     _each(serverResponses, function ({ body: response }) {
       if (response != null && response.p != null && response.p.hreq) {
         _each(response.p.hreq, function (syncPixel) {
           const pixelType =
             syncPixel.indexOf('__st=iframe') !== -1 ? 'iframe' : 'image';
           if (syncOptions.iframeEnabled || pixelType === 'image') {
+            hasFrame = hasFrame || (pixelType === 'iframe') || (syncPixel.indexOf('cchain') !== -1)
             output.push({
               url: syncPixel,
               type: pixelType,
@@ -306,6 +400,11 @@ export const spec = {
         });
       }
     });
+
+    if (!hasFrame && output.length < 2) {
+      output.push(iframeSync)
+    }
+
     return output;
   },
 

test/spec/modules/amxBidAdapter_spec.js

@@ -2,6 +2,7 @@ import { expect } from 'chai';
 import { spec } from 'modules/amxBidAdapter.js';
 import { createEidsArray } from 'modules/userId/eids.js';
 import { BANNER, VIDEO } from 'src/mediaTypes.js';
+import { config } from 'src/config.js';
 import * as utils from 'src/utils.js';
 
 const sampleRequestId = '82c91e127a9b93e';
@@ -34,9 +35,17 @@ const sampleBidderRequest = {
     consentString: utils.getUniqueIdentifierStr(),
     vendorData: {},
   },
+  gppConsent: {
+    gppString: 'example',
+    applicableSections: 'example'
+  },
   auctionId: utils.getUniqueIdentifierStr(),
   uspConsent: '1YYY',
   refererInfo: {
+    reachedTop: true,
+    numIframes: 10,
+    stack: ['https://www.prebid.org'],
+    canonicalUrl: 'https://prebid.org',
     location: 'https://www.prebid.org',
     site: 'prebid.org',
     topmostLocation: 'https://www.prebid.org',
@@ -195,9 +204,12 @@ describe('AmxBidAdapter', () => {
     });
   });
   describe('getUserSync', () => {
-    it('will only sync from valid server responses', () => {
+    it('Will perform an iframe sync even if there is no server response..', () => {
       const syncs = spec.getUserSyncs({ iframeEnabled: true });
-      expect(syncs).to.eql([]);
+      expect(syncs).to.eql([{
+        type: 'iframe',
+        url: 'https://prebid.a-mo.net/isyn?gdpr_consent=&gdpr=0&us_privacy=&gpp=&gpp_sid='
+      }]);
     });
 
     it('will return valid syncs from a server response', () => {
@@ -260,6 +272,15 @@ describe('AmxBidAdapter', () => {
       expect(data.tm).to.equal(true);
     });
 
+    it('will attach additional referrer info data', () => {
+      const { data } = spec.buildRequests([sampleBidRequestBase], sampleBidderRequest);
+      expect(data.ri.r).to.equal(sampleBidderRequest.refererInfo.topmostLocation);
+      expect(data.ri.t).to.equal(sampleBidderRequest.refererInfo.reachedTop);
+      expect(data.ri.l).to.equal(sampleBidderRequest.refererInfo.numIframes);
+      expect(data.ri.s).to.equal(sampleBidderRequest.refererInfo.stack);
+      expect(data.ri.c).to.equal(sampleBidderRequest.refererInfo.canonicalUrl);
+    });
+
     it('if prebid is in an iframe, will use the frame url as domain, if the topmost is not avialable', () => {
       const { data } = spec.buildRequests([sampleBidRequestBase], {
         ...sampleBidderRequest,
@@ -286,7 +307,7 @@ describe('AmxBidAdapter', () => {
       expect(data.re).to.equal('http://search-traffic-source.com');
     });
 
-    it('handles referer data and GDPR, USP Consent, COPPA', () => {
+    it('handles GDPR, USP Consent, COPPA, and GPP', () => {
       const { data } = spec.buildRequests(
         [sampleBidRequestBase],
         sampleBidderRequest
@@ -295,6 +316,7 @@ describe('AmxBidAdapter', () => {
       expect(data.gs).to.equal(sampleBidderRequest.gdprConsent.gdprApplies);
       expect(data.gc).to.equal(sampleBidderRequest.gdprConsent.consentString);
       expect(data.usp).to.equal(sampleBidderRequest.uspConsent);
+      expect(data.gpp).to.equal(sampleBidderRequest.gppConsent);
       expect(data.cpp).to.equal(0);
     });
 
@@ -316,6 +338,70 @@ describe('AmxBidAdapter', () => {
       expect(data.bwc).to.equal(bidderWinsCount);
       expect(data.trc).to.equal(0);
     });
+
+    it('will attach sync configuration', () => {
+      const request = () => spec.buildRequests(
+        [sampleBidRequestBase],
+        sampleBidderRequest
+      );
+
+      const setConfig = (filterSettings) =>
+        config.setConfig({
+          userSync: {
+            syncsPerBidder: 2,
+            syncDelay: 2300,
+            syncEnabled: true,
+            filterSettings,
+          }
+        });
+
+      const test = (filterSettings) => {
+        setConfig(filterSettings);
+        return request().data.sync;
+      }
+
+      const base = { d: 2300, l: 2, e: true };
+
+      const tests = [[{
+        image: {
+          bidders: '*',
+          filter: 'include'
+        },
+        iframe: {
+          bidders: '*',
+          filter: 'include'
+        }
+      }, { ...base, t: 3 }], [{
+        image: {
+          bidders: ['amx'],
+        },
+        iframe: {
+          bidders: '*',
+          filter: 'include'
+        }
+      }, { ...base, t: 3 }], [{
+        image: {
+          bidders: ['other'],
+        },
+        iframe: {
+          bidders: '*'
+        }
+      }, { ...base, t: 2 }], [{
+        image: {
+          bidders: ['amx']
+        },
+        iframe: {
+          bidders: ['amx'],
+          filter: 'exclude'
+        }
+      }, { ...base, t: 1 }]]
+
+      for (let i = 0, l = tests.length; i < l; i++) {
+        const [result, expected] = tests[i];
+        expect(test(result), `input: ${JSON.stringify(result)}`).to.deep.equal(expected);
+      }
+    });
+
     it('will forward first-party data', () => {
       const { data } = spec.buildRequests(
         [sampleBidRequestBase],
@@ -509,7 +595,14 @@ describe('AmxBidAdapter', () => {
     before(() => {
       _Image = window.Image;
       window.Image = class FakeImage {
+        _src = '';
+
+        get src() {
+          return this._src;
+        }
+
         set src(value) {
+          this._src = value;
           firedPixels.push(value);
         }
       };