@highfivve/ad-tag 5.8.11 → 5.8.12

package/lib/ads/auctions/frequencyCapping.js

@@ -3,15 +3,26 @@ import { resolveAdUnitPath } from '../adUnitPath';
 import { formatKey } from 'ad-tag/ads/keyValues';
 import { isGamInterstitial } from 'ad-tag/ads/auctions/interstitialContext';
 const sessionStorageKey = 'h5v-fc';
+const localStorageKey = 'h5v-pi';
 const hasPacingInterval = (config) => !!config.conditions && !!config.conditions.pacingInterval;
 export const createFrequencyCapping = (config, _window, now, logger) => {
     const positionImpSchedules = new Map();
     const positionLastImpressionNumberOfAdRequests = new Map();
     const bidderImpSchedules = new Map();
     const positionAdRequests = new Map();
-    let numAdRequests = 0;
-    const pageImpressionStorageKey = 'h5v_pi';
-    let currentPageImpression = Number(_window.localStorage.getItem(pageImpressionStorageKey) ?? '0');
+    let sessionNumAdRequests = 0;
+    let totalNumAdRequests = 0;
+    let existingLocalStorageData = null;
+    try {
+        const stored = _window.localStorage.getItem(localStorageKey);
+        if (stored) {
+            existingLocalStorageData = JSON.parse(stored);
+            totalNumAdRequests = existingLocalStorageData.requestAds;
+        }
+    }
+    catch (e) {
+        logger.debug('fc', 'failed to parse localStorage data, starting fresh', e);
+    }
     const pacingIntervalConfigs = config.bidders?.filter(hasPacingInterval) ?? [];
     const bidWonConfigs = pacingIntervalConfigs.filter(config => !config.conditions.pacingInterval?.events ||
         config.conditions.pacingInterval?.events?.includes('bidWon')) ?? [];
@@ -22,12 +33,20 @@ export const createFrequencyCapping = (config, _window, now, logger) => {
             const data = {
                 bCaps: Array.from(bidderImpSchedules.entries()).reduce((acc, [key, schedules]) => ({ ...acc, [key]: schedules }), {}),
                 pCaps: Array.from(positionImpSchedules.entries()).reduce((acc, [adUnitPath, schedules]) => ({ ...acc, [adUnitPath]: schedules }), {}),
-                pLastImpAdRequests: Array.from(positionLastImpressionNumberOfAdRequests.entries()).reduce((acc, [adUnitPath, numAdRequests]) => ({ ...acc, [adUnitPath]: numAdRequests }), {}),
-                requestAds: numAdRequests
+                pLastImpAdRequests: Array.from(positionLastImpressionNumberOfAdRequests.entries()).reduce((acc, [adUnitPath, sessionNumAdRequests]) => ({
+                    ...acc,
+                    [adUnitPath]: sessionNumAdRequests
+                }), {}),
+                requestAds: sessionNumAdRequests
             };
             _window.sessionStorage.setItem(sessionStorageKey, JSON.stringify(data));
         }
-        _window.localStorage.setItem(pageImpressionStorageKey, JSON.stringify(currentPageImpression));
+        const dataToStoreInLocalStorage = {
+            createdAt: existingLocalStorageData?.createdAt ?? Date.now(),
+            ts: Date.now(),
+            requestAds: totalNumAdRequests
+        };
+        _window.localStorage.setItem(localStorageKey, JSON.stringify(dataToStoreInLocalStorage));
     };
     const cap = (startTimestamp, config, intervalInMs, bid) => {
         const bidders = config.bidders;
@@ -69,7 +88,7 @@ export const createFrequencyCapping = (config, _window, now, logger) => {
                 capPosition(now(), adUnitPath, config.conditions.pacingInterval);
             }
             if (config.conditions.pacingRequestAds) {
-                positionLastImpressionNumberOfAdRequests.set(adUnitPath, numAdRequests);
+                positionLastImpressionNumberOfAdRequests.set(adUnitPath, sessionNumAdRequests);
                 persist();
             }
         });
@@ -79,7 +98,7 @@ export const createFrequencyCapping = (config, _window, now, logger) => {
         if (storedData) {
             try {
                 const parsedData = JSON.parse(storedData);
-                numAdRequests = parsedData.requestAds;
+                sessionNumAdRequests = parsedData.requestAds;
                 Object.entries(parsedData.bCaps).forEach(([adUnitBidderKey, schedules]) => {
                     schedules?.forEach(schedule => {
                         const [adUnitCode, bidder] = adUnitBidderKey.split(':');
@@ -145,8 +164,8 @@ export const createFrequencyCapping = (config, _window, now, logger) => {
             positionAdRequests.clear();
         },
         afterRequestAds() {
-            numAdRequests++;
-            currentPageImpression++;
+            sessionNumAdRequests++;
+            totalNumAdRequests++;
             persist();
         },
         updateAdUnitPaths(adUnitPathVariables) {
@@ -162,11 +181,12 @@ export const createFrequencyCapping = (config, _window, now, logger) => {
                 .some(positionConfig => {
                 return ((positionConfig.adUnitPath === adUnitPath &&
                     positionConfig.conditions.delay &&
-                    numAdRequests <
+                    sessionNumAdRequests <
                         positionConfig.conditions.delay.minRequestAds - (isGamInst ? 1 : 0)) ||
                     (positionConfig.conditions.pacingRequestAds &&
                         positionLastImpressionNumberOfAdRequests.has(adUnitPath) &&
-                        numAdRequests - (positionLastImpressionNumberOfAdRequests.get(adUnitPath) ?? 0) <
+                        sessionNumAdRequests -
+                            (positionLastImpressionNumberOfAdRequests.get(adUnitPath) ?? 0) <
                             positionConfig.conditions.pacingRequestAds.requestAds) ||
                     (positionConfig.conditions.pacingInterval &&
                         (positionImpSchedules.get(adUnitPath) ?? []).length >=
@@ -186,11 +206,11 @@ export const createFrequencyCapping = (config, _window, now, logger) => {
                 return ((pacingInterval &&
                     (bidderImpSchedules.get(`${slotId}:${bidder}`) ?? []).length >=
                         pacingInterval.maxImpressions) ||
-                    (delay && numAdRequests < delay.minRequestAds));
+                    (delay && sessionNumAdRequests < delay.minRequestAds));
             });
         },
-        getCurrentPageImpressionFromLocalStorage() {
-            return currentPageImpression;
+        getTotalNumAdRequests() {
+            return totalNumAdRequests;
         }
     };
 };

package/lib/ads/globalAuctionContext.js

@@ -92,11 +92,11 @@ export const createGlobalAuctionContext = (window, logger, eventService, config
         interstitialChannel: () => {
             return interstitial?.interstitialChannel();
         },
-        hasMinimumPageImpressions(minRequestAds) {
+        hasMinimumRequestAds(minRequestAds) {
             if (!frequencyCapping) {
                 return true;
             }
-            const currentPageImpression = frequencyCapping.getCurrentPageImpressionFromLocalStorage();
+            const currentPageImpression = frequencyCapping.getTotalNumAdRequests();
             return currentPageImpression >= minRequestAds;
         },
         configureStep() {

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

@@ -26,7 +26,7 @@ export class AdReload {
             this.initialized = true;
         };
         this.setupAdVisibilityService = (config, window, logger) => {
-            this.adVisibilityService = new AdVisibilityService(new UserActivityService(window, config.userActivityLevelControl, logger), this.refreshIntervalMs, config.refreshIntervalMsOverrides ?? {}, false, !!config.disableAdVisibilityChecks, config.viewabilityOverrides ?? {}, window, logger);
+            this.adVisibilityService = new AdVisibilityService(new UserActivityService(window, config.userActivityLevelControl, logger), config.refreshIntervalMs ?? this.refreshIntervalMs, config.refreshIntervalMsOverrides ?? {}, false, !!config.disableAdVisibilityChecks, config.viewabilityOverrides ?? {}, window, logger);
         };
         this.setupSlotRenderListener = (config, slotsToMonitor, reloadAdSlotCallback, window, logger) => window.googletag.pubads().addEventListener('slotRenderEnded', renderEndedEvent => {
             const { slot: googleTagSlot, campaignId, advertiserId, companyIds, yieldGroupIds, isEmpty: slotIsEmpty } = renderEndedEvent;

package/lib/ads/modules/utiq/index.js

@@ -34,7 +34,7 @@ export const createUtiq = () => {
             return Promise.resolve();
         }
         const minAdRequests = config.delay?.enabled && config.delay.minAdRequests ? config.delay.minAdRequests : 0;
-        if (!context.auction__.hasMinimumPageImpressions(minAdRequests)) {
+        if (!context.auction__.hasMinimumRequestAds(minAdRequests)) {
             context.logger__.info('Utiq', `not enough ad requests to load Utiq. ${minAdRequests} required.`);
             return Promise.resolve();
         }

package/lib/gen/packageJson.js

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

package/package.json

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