@highfivve/ad-tag 5.11.5 → 5.11.7

package/lib/ads/modules/ad-reload/index.js

@@ -1,9 +1,9 @@
 import { AdVisibilityService } from './adVisibilityService';
 import { UserActivityService } from './userActivityService';
 import { mkConfigureStep } from '../../adPipeline';
-import { isNotNull } from 'ad-tag/util/arrayUtils';
 import { isAdvertiserIncluded } from 'ad-tag/ads/isAdvertiserIncluded';
 import { formatKey } from 'ad-tag/ads/keyValues';
+import { resolveAdUnitPath } from 'ad-tag/ads/adUnitPath';
 import { asViewabilityOverrideEntryList, resolveViewabilityOverride } from './viewabilityOverride';
 export const createAdReload = () => {
     const name = 'moli-ad-reload';
@@ -59,14 +59,28 @@ export const createAdReload = () => {
     };
     const reloadAdSlot = (config, ctx) => (googleTagSlot) => {
         const slotId = googleTagSlot.getSlotElementId();
-        const moliSlot = ctx.config__.slots.find(moliSlot => moliSlot.domId === slotId);
+        const slotAdUnitPath = googleTagSlot.getAdUnitPath();
+        const moliSlot = ctx.config__.slots.find(candidate => {
+            if (candidate.domId === slotId) {
+                return true;
+            }
+            if (!slotAdUnitPath) {
+                return false;
+            }
+            try {
+                return (resolveAdUnitPath(candidate.adUnitPath, ctx.adUnitPathVariables__) === slotAdUnitPath);
+            }
+            catch (e) {
+                return false;
+            }
+        });
         if (moliSlot && moliSlot.behaviour.loaded !== 'infinite') {
             ctx.logger__.debug('AdReload', 'fired slot reload', moliSlot.domId);
             const sizesOverride = maybeOptimizeSlotForCls(config, moliSlot, googleTagSlot, ctx.logger__, ctx.window__);
             googleTagSlot.setTargeting(reloadKeyValue, 'true');
             const getBucketAndLoadingBehaviour = () => {
                 const [liveFormat] = googleTagSlot.getTargeting(formatKey);
-                const matchedOverride = resolveViewabilityOverride(asViewabilityOverrideEntryList(config.viewabilityOverrides?.[slotId]), liveFormat);
+                const matchedOverride = resolveViewabilityOverride(asViewabilityOverrideEntryList(config.viewabilityOverrides?.[moliSlot.domId]), liveFormat);
                 if (matchedOverride?.refreshBucket === true) {
                     const loaded = moliSlot.behaviour.loaded;
                     const bucket = moliSlot.behaviour.bucket;
@@ -85,18 +99,21 @@ export const createAdReload = () => {
             }
             else {
                 ctx.window__.moli
-                    .refreshAdSlot(slotId, {
+                    .refreshAdSlot(moliSlot.domId, {
                     loaded: moliSlot.behaviour.loaded,
                     ...(sizesOverride && { sizesOverride: sizesOverride })
                 })
-                    .catch(error => ctx.logger__.error('AdReload', `refreshing ${slotId} failed`, error));
+                    .catch(error => ctx.logger__.error('AdReload', `refreshing ${moliSlot.domId} failed`, error));
             }
         }
     };
     const setupSlotRenderListener = (config, slotsToMonitor, reloadAdSlotCallback, window, logger) => window.googletag.pubads().addEventListener('slotRenderEnded', renderEndedEvent => {
         const { slot: googleTagSlot, campaignId, advertiserId, companyIds, yieldGroupIds, isEmpty: slotIsEmpty } = renderEndedEvent;
         const slotDomId = googleTagSlot.getSlotElementId();
-        const slotIsMonitored = slotsToMonitor.indexOf(slotDomId) > -1;
+        const slotAdUnitPath = googleTagSlot.getAdUnitPath();
+        const monitoredSlot = slotsToMonitor.find(monitored => monitored.domId === slotDomId ||
+            (!!slotAdUnitPath && monitored.adUnitPath === slotAdUnitPath));
+        const slotIsMonitored = !!monitoredSlot;
         const orderIdNotExcluded = !campaignId || config.excludeOrderIds.indexOf(campaignId) === -1;
         const orderIdIncluded = !!campaignId && config.includeOrderIds.indexOf(campaignId) > -1;
         const advertiserIdIncluded = isAdvertiserIncluded(renderEndedEvent, config.includeAdvertiserIds);
@@ -117,7 +134,7 @@ export const createAdReload = () => {
         }
         const slotAlreadyTracked = !!adVisibilityService?.isSlotTracked(slotDomId);
         if (trackingSlotAllowed) {
-            const bidderCode = globalAuctionContext?.getLastWinningBidderOfAdUnit(slotDomId);
+            const bidderCode = monitoredSlot && globalAuctionContext?.getLastWinningBidderOfAdUnit(monitoredSlot.domId);
             adVisibilityService.trackSlot(googleTagSlot, reloadAdSlotCallback, advertiserId, companyIds, bidderCode);
         }
         else if (slotAlreadyTracked) {
@@ -144,9 +161,19 @@ export const createAdReload = () => {
             ? [
                 mkConfigureStep(name, context => {
                     const slotsToMonitor = context.config__.slots
-                        .filter(slot => config.excludeAdSlotDomIds.indexOf(slot.domId) === -1)
-                        .map(slot => slot.domId)
-                        .filter(isNotNull);
+                        .filter(slot => !!slot.domId && config.excludeAdSlotDomIds.indexOf(slot.domId) === -1)
+                        .map(slot => {
+                        try {
+                            return {
+                                domId: slot.domId,
+                                adUnitPath: resolveAdUnitPath(slot.adUnitPath, context.adUnitPathVariables__)
+                            };
+                        }
+                        catch (e) {
+                            context.logger__.error('AdReload', `failed to resolve adUnitPath '${slot.adUnitPath}' for domId ${slot.domId}, monitoring by domId only`, e);
+                            return { domId: slot.domId, adUnitPath: '' };
+                        }
+                    });
                     const reloadAdSlotCallback = reloadAdSlot(config, context);
                     context.logger__.debug('AdReload', 'monitoring slots', slotsToMonitor);
                     initialize(context, config, slotsToMonitor, reloadAdSlotCallback);

package/lib/gen/packageJson.js

@@ -1,3 +1,3 @@
 export const packageJson = {
-    version: '5.11.5'
+    version: '5.11.7'
 };

package/lib/util/logging.js

@@ -60,16 +60,16 @@ function getSourceLabelStyle(source) {
 export function getDefaultLogger() {
     return {
         debug(source, message, ...optionalParams) {
-            console.debug(`%c[DEBUG]%c${source}%c${message}`, getLogStageLabelStyle('debug'), getSourceLabelStyle(source), '', ...optionalParams);
+            console.debug(`%c[DEBUG] %c${source} %c${message}`, getLogStageLabelStyle('debug'), getSourceLabelStyle(source), '', ...optionalParams);
         },
         info(source, message, ...optionalParams) {
-            console.info(`%c[INFO]%c${source}%c${message}`, getLogStageLabelStyle('info'), getSourceLabelStyle(source), '', ...optionalParams);
+            console.info(`%c[INFO] %c${source} %c${message}`, getLogStageLabelStyle('info'), getSourceLabelStyle(source), '', ...optionalParams);
         },
         warn(source, message, ...optionalParams) {
-            console.warn(`%c[WARN]%c${source}%c${message}`, getLogStageLabelStyle('warn'), getSourceLabelStyle(source), '', ...optionalParams);
+            console.warn(`%c[WARN] %c${source} %c${message}`, getLogStageLabelStyle('warn'), getSourceLabelStyle(source), '', ...optionalParams);
         },
         error(source, message, ...optionalParams) {
-            console.error(`%c[ERROR]%c${source}%c${message}`, getLogStageLabelStyle('error'), getSourceLabelStyle(source), '', ...optionalParams);
+            console.error(`%c[ERROR] %c${source} %c${message}`, getLogStageLabelStyle('error'), getSourceLabelStyle(source), '', ...optionalParams);
         }
     };
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@highfivve/ad-tag",
-  "version": "5.11.5",
+  "version": "5.11.7",
   "license": "Apache-2.0",
   "description": "An ad tag implementation called moli",
   "main": "./lib/index.js",