MNY-3670: listen to ids from user sync

gannet-modules.json

@@ -0,0 +1,16 @@
+[
+  "appnexusBidAdapter",
+  "ixBidAdapter",
+  "yahoosspBidAdapter",
+  "openxBidAdapter",
+  "pubmaticBidAdapter",
+  "rubiconBidAdapter",
+  "sonobiBidAdapter",
+  "tripleliftBidAdapter",
+  "gridBidAdapter",
+  "undertoneBidAdapter",
+  "consentManagementGpp",
+  "topicsFpdModule",
+  "gptPreAuction",
+  "dfpAdServerVideo"
+]

modules.json

@@ -0,0 +1,63 @@
+[
+  "appnexusBidAdapter",
+  "ixBidAdapter",
+  "openxBidAdapter",
+  "pubmaticBidAdapter",
+  "rhythmoneBidAdapter",
+  "rubiconBidAdapter",
+  "telariaBidAdapter",
+  "medianetBidAdapter",
+  "admanBidAdapter",
+  "imdsBidAdapter",
+  "undertoneBidAdapter",
+  "amxBidAdapter",
+  "smaatoBidAdapter",
+  "smartadserverBidAdapter",
+  "gridBidAdapter",
+  "riseBidAdapter",
+  "yahooAdsBidAdapter",
+  "unrulyBidAdapter",
+  "kargoBidAdapter",
+  "smilewantedBidAdapter",
+  "krushmediaBidAdapter",
+  "cadentApertureMXBidAdapter",
+  "conversantBidAdapter",
+  "criteoBidAdapter",
+  "tripleliftBidAdapter",
+  "pulsepointBidAdapter",
+  "adtelligentBidAdapter",
+  "yieldmoBidAdapter",
+  "aniviewBidAdapter",
+  "nextMillenniumBidAdapter",
+  "colossussspBidAdapter",
+  "resetdigitalBidAdapter",
+  "mediafuseBidAdapter",
+  "freewheel-sspBidAdapter",
+  "adyoulikeBidAdapter",
+  "minutemediaBidAdapter",
+  "sharethroughBidAdapter",
+  "insticatorBidAdapter",
+  "sonobiBidAdapter",
+  "pgamsspBidAdapter",
+  "ozoneBidAdapter",
+  "showheroes-bsBidAdapter",
+  "seedtagBidAdapter",
+  "sovrnBidAdapter",
+  "kueezRtbBidAdapter",
+  "adpod",
+  "consentManagementTcf",
+  "consentManagementUsp",
+  "consentManagementGpp",
+  "tcfControl",
+  "currency",
+  "priceFloors",
+  "schain",
+  "userId",
+  "identityLinkIdSystem",
+  "criteoIdSystem",
+  "sharedIdSystem",
+  "uid2IdSystem",
+  "rtdModule",
+  "permutiveRtdProvider",
+  "pubProvidedIdSystem"
+]

modules/connatixBidAdapter.js

@@ -9,7 +9,7 @@ import {
   isArray,
   formatQS
 } from '../src/utils.js';
-
+import {getStorageManager} from '../src/storageManager.js';
 import {
   BANNER,
 } from '../src/mediaTypes.js';
@@ -18,6 +18,9 @@ const BIDDER_CODE = 'connatix';
 const AD_URL = 'https://capi.connatix.com/rtb/hba';
 const DEFAULT_MAX_TTL = '3600';
 const DEFAULT_CURRENCY = 'USD';
+const CNX_IDS = 'cnx_ids';
+const CNX_ID_RETENTION_TIME_HOUR = 24 * 30; // 30 days
+export const storage = getStorageManager({ bidderCode: BIDDER_CODE });
 
 /*
  * Get the bid floor value from the bid object, either using the getFloor function or by accessing the 'params.bidfloor' property.
@@ -41,6 +44,21 @@ export function getBidFloor(bid) {
   }
 }
 
+function saveOnAllStorages(name, value, expirationTimeHours) {
+  const date = new Date();
+  date.setTime(date.getTime() + (expirationTimeHours * 60 * 60 * 1000));
+  const expires = `expires=${date.toUTCString()}`;
+  storage.setCookie(name, value, expires);
+  storage.setDataInLocalStorage(name, value);
+}
+
+function readFromAllStorages(name) {
+  const fromCookie = storage.getCookie(name);
+  const fromLocalStorage = storage.getDataFromLocalStorage(name);
+
+  return fromCookie || fromLocalStorage || undefined;
+}
+
 export const spec = {
   code: BIDDER_CODE,
   gvlid: 143,
@@ -94,12 +112,14 @@ export const spec = {
       };
     });
 
+    const cnxIds = readFromAllStorages(CNX_IDS);
     const requestPayload = {
       ortb2: bidderRequest.ortb2,
       gdprConsent: bidderRequest.gdprConsent,
       uspConsent: bidderRequest.uspConsent,
       gppConsent: bidderRequest.gppConsent,
       refererInfo: bidderRequest.refererInfo,
+      userIds: cnxIds,
       bidRequests,
     };
 
@@ -171,6 +191,20 @@ export const spec = {
       params['us_privacy'] = encodeURIComponent(uspConsent);
     }
 
+    window.addEventListener('message', function handler(event) {
+      if (!event.data || !event.origin.includes('connatix')) {
+        return;
+      }
+      this.removeEventListener('message', handler);
+
+      event.stopImmediatePropagation();
+
+      const response = event.data;
+      if (!response.optout && response.eids) {
+        saveOnAllStorages(CNX_IDS, response.eids, CNX_ID_RETENTION_TIME_HOUR);
+      }
+    }, true)
+
     const syncUrl = serverResponses[0].body.UserSyncEndpoint;
     const queryParams = Object.keys(params).length > 0 ? formatQS(params) : '';
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "prebid.js",
-  "version": "9.4.0",
+  "version": "9.4.1",
   "description": "Header Bidding Management Library",
   "main": "src/prebid.public.js",
   "exports": {
@@ -15,7 +15,9 @@
   "scripts": {
     "serve": "gulp serve",
     "test": "gulp test",
-    "lint": "gulp lint"
+    "lint": "gulp lint",
+    "build:connatix": "gulp build-bundle-prod --disable NATIVE --modules=modules.json",
+    "build:connatix:gannett": "gulp build-bundle-prod --disable NATIVE --modules=gannet-modules.json"
   },
   "repository": {
     "type": "git",

src/adRendering.js

@@ -253,8 +253,12 @@ export function renderAdDirect(doc, adId, options) {
  */
 export function insertLocatorFrame() {
   if (!window.frames[PB_LOCATOR]) {
-    const frame = createInvisibleIframe();
-    frame.name = PB_LOCATOR;
-    document.body.appendChild(frame);
+    if (!document.body) {
+      window.requestAnimationFrame(insertLocatorFrame);
+    } else {
+      const frame = createInvisibleIframe();
+      frame.name = PB_LOCATOR;
+      document.body.appendChild(frame);
+    }
   }
 }

test/pages/banner_sync.html

@@ -0,0 +1,97 @@
+<!-- This is a Test Page for a Banner End-to-End test  -->
+<!DOCTYPE html>
+<html lang="en">
+
+<head>
+    <meta charset="UTF-8">
+    <title>Prebid.js Banner Example</title>
+
+    <!-- Prebid.js -->
+    <script src="http://localhost:4444/bundle?modules=appnexusBidAdapter"></script>
+
+    <!-- Google Publisher Tag -->
+    <script async src="https://www.googletagservices.com/tag/js/gpt.js"></script>
+
+    <script>
+        var pbjs = pbjs || {};
+        pbjs.que = pbjs.que || [];
+
+        // Prebid Banner Ad Unit
+        const adUnits = [{
+            code: 'div-gpt-ad-1460505748561-0',
+            mediaTypes: {
+                banner: {
+                    sizes: [[300, 250], [300, 600]],
+                }
+            },
+            bids: [{
+                bidder: 'appnexus',
+                params: {
+                    placementId: 13144370
+                }
+            }]
+        }
+            ,{
+                code: 'div-gpt-ad-1460505748561-1',
+                mediaTypes: {
+                    banner: {
+                        sizes: [[300, 250], [300, 600]],
+                    }
+                },
+                bids: [{
+                    bidder: "appnexus",
+                    params: {
+                        placementId: 13144370
+                    }
+                }]
+            }
+        ];
+    </script>
+
+    <script>
+        var googletag = googletag || {};
+        googletag.cmd = googletag.cmd || [];
+
+        googletag.cmd.push(function() {
+            googletag.pubads().disableInitialLoad();
+        });
+
+        pbjs.que.push(function () {
+            pbjs.setConfig({enableTIDs: true});
+            pbjs.addAdUnits(adUnits);
+            pbjs.requestBids({ bidsBackHandler: sendAdServerRequest });
+        });
+
+        function sendAdServerRequest() {
+            googletag.cmd.push(function () {
+                pbjs.que.push(function () {
+                    pbjs.setTargetingForGPTAsync('div-gpt-ad-1460505748561-0');
+                    googletag.pubads().refresh();
+                });
+            });
+        }
+    </script>
+
+    <script>
+        googletag.cmd.push(function () {
+            googletag
+                .defineSlot('/19968336/header-bid-tag-0', [[300, 250], [300, 600]], 'div-gpt-ad-1460505748561-0')
+                .addService(googletag.pubads());
+
+            googletag.pubads().enableSingleRequest();
+            googletag.enableServices();
+        });
+    </script>
+</head>
+
+<body>
+<h2>Prebid.js Banner Ad Unit Test</h2>
+<div id='div-gpt-ad-1460505748561-0'>
+    <script>
+        googletag.cmd.push(function () { googletag.display('div-gpt-ad-1460505748561-0'); });
+    </script>
+</div>
+<div id="targeting-keys"></div>
+</body>
+
+</html>

test/spec/e2e/banner/basic_banner_ad.spec.js

@@ -2,6 +2,7 @@ const expect = require('chai').expect;
 const {setupTest, testPageURL} = require('../../../helpers/testing-utils');
 
 const TEST_PAGE_URL = testPageURL('banner.html?pbjs_debug=true');
+const SYNC_PAGE_URL = testPageURL('banner_sync.html?pbjs_debug=true');
 const CREATIVE_IFRAME_ID = 'google_ads_iframe_/19968336/header-bid-tag-0_0';
 const CREATIVE_IFRAME_CSS_SELECTOR = 'iframe[id="' + CREATIVE_IFRAME_ID + '"]';
 
@@ -14,20 +15,25 @@ const EXPECTED_TARGETING_KEYS = {
   'hb_bidder_appnexus': 'appnexus'
 };
 
-setupTest({
-  url: TEST_PAGE_URL,
-  waitFor: CREATIVE_IFRAME_CSS_SELECTOR,
-  expectGAMCreative: true
-}, 'Prebid.js Banner Ad Unit Test', function () {
-  it('should load the targeting keys with correct values', async function () {
-    const result = await browser.execute(function () {
-      return window.pbjs.getAdserverTargeting('div-gpt-ad-1460505748561-1');
-    });
-    const targetingKeys = result['div-gpt-ad-1460505748561-1'];
+Object.entries({
+  'synchronously': SYNC_PAGE_URL,
+  'asynchronously': TEST_PAGE_URL,
+}).forEach(([t, testPage]) => {
+  setupTest({
+    url: testPage,
+    waitFor: CREATIVE_IFRAME_CSS_SELECTOR,
+    expectGAMCreative: true
+  }, `Prebid.js Banner Ad Unit Test (loading ${t})`, function () {
+    it('should load the targeting keys with correct values', async function () {
+      const result = await browser.execute(function () {
+        return window.pbjs.getAdserverTargeting('div-gpt-ad-1460505748561-1');
+      });
+      const targetingKeys = result['div-gpt-ad-1460505748561-1'];
 
-    expect(targetingKeys).to.include(EXPECTED_TARGETING_KEYS);
-    expect(targetingKeys.hb_adid).to.be.a('string');
-    expect(targetingKeys.hb_adid_appnexus).to.be.a('string');
-    expect(targetingKeys.hb_size).to.satisfy((size) => size === '300x250' || '300x600');
+      expect(targetingKeys).to.include(EXPECTED_TARGETING_KEYS);
+      expect(targetingKeys.hb_adid).to.be.a('string');
+      expect(targetingKeys.hb_adid_appnexus).to.be.a('string');
+      expect(targetingKeys.hb_size).to.satisfy((size) => size === '300x250' || '300x600');
+    });
   });
 });