@highfivve/ad-tag 5.8.9 → 5.8.11

package/lib/ads/auctions/frequencyCapping.js

@@ -10,6 +10,8 @@ export const createFrequencyCapping = (config, _window, now, logger) => {
     const bidderImpSchedules = new Map();
     const positionAdRequests = new Map();
     let numAdRequests = 0;
+    const pageImpressionStorageKey = 'h5v_pi';
+    let currentPageImpression = Number(_window.localStorage.getItem(pageImpressionStorageKey) ?? '0');
     const pacingIntervalConfigs = config.bidders?.filter(hasPacingInterval) ?? [];
     const bidWonConfigs = pacingIntervalConfigs.filter(config => !config.conditions.pacingInterval?.events ||
         config.conditions.pacingInterval?.events?.includes('bidWon')) ?? [];
@@ -25,6 +27,7 @@ export const createFrequencyCapping = (config, _window, now, logger) => {
             };
             _window.sessionStorage.setItem(sessionStorageKey, JSON.stringify(data));
         }
+        _window.localStorage.setItem(pageImpressionStorageKey, JSON.stringify(currentPageImpression));
     };
     const cap = (startTimestamp, config, intervalInMs, bid) => {
         const bidders = config.bidders;
@@ -143,6 +146,7 @@ export const createFrequencyCapping = (config, _window, now, logger) => {
         },
         afterRequestAds() {
             numAdRequests++;
+            currentPageImpression++;
             persist();
         },
         updateAdUnitPaths(adUnitPathVariables) {
@@ -185,8 +189,8 @@ export const createFrequencyCapping = (config, _window, now, logger) => {
                     (delay && numAdRequests < delay.minRequestAds));
             });
         },
-        getRequestAdsCount() {
-            return numAdRequests;
+        getCurrentPageImpressionFromLocalStorage() {
+            return currentPageImpression;
         }
     };
 };

package/lib/ads/globalAuctionContext.js

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

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

@@ -1,5 +1,5 @@
 import { tcfapi } from 'ad-tag/types/tcfapi';
-import { mkInitStep } from 'ad-tag/ads/adPipeline';
+import { mkInitStep, mkConfigureStepOncePerRequestAdsCycle } from 'ad-tag/ads/adPipeline';
 import { AssetLoadMethod } from 'ad-tag/util/assetLoaderService';
 const requiredPurposeIds = [
     tcfapi.responses.TCPurpose.STORE_INFORMATION_ON_DEVICE,
@@ -16,15 +16,14 @@ const requiredPurposeIds = [
 ];
 export const createUtiq = () => {
     let utiqConfig = null;
-    let loaded = false;
+    let scriptLoaded = false;
     const loadUtiq = (config, context) => {
         if (context.env__ === 'test') {
             return Promise.resolve();
         }
-        if (loaded) {
+        if (scriptLoaded) {
             return Promise.resolve();
         }
-        loaded = true;
         const utiqWindow = context.window__;
         utiqWindow.Utiq = utiqWindow.Utiq
             ? { ...utiqWindow.Utiq, config: { ...utiqWindow.Utiq.config, ...config.options } }
@@ -35,7 +34,7 @@ export const createUtiq = () => {
             return Promise.resolve();
         }
         const minAdRequests = config.delay?.enabled && config.delay.minAdRequests ? config.delay.minAdRequests : 0;
-        if (!context.auction__.hasMinimumRequestAds(minAdRequests)) {
+        if (!context.auction__.hasMinimumPageImpressions(minAdRequests)) {
             context.logger__.info('Utiq', `not enough ad requests to load Utiq. ${minAdRequests} required.`);
             return Promise.resolve();
         }
@@ -45,7 +44,12 @@ export const createUtiq = () => {
             loadMethod: AssetLoadMethod.TAG,
             assetUrl: config.assetUrl
         })
-            .catch(error => context.logger__.error('failed to load utiq', error));
+            .then(() => {
+            scriptLoaded = true;
+        })
+            .catch(error => {
+            context.logger__.error('failed to load utiq', error);
+        });
     };
     const hasDelayEnabled = (config) => {
         return config?.delay?.enabled ?? false;
@@ -69,7 +73,7 @@ export const createUtiq = () => {
         },
         configureSteps__() {
             return utiqConfig?.enabled && hasDelayEnabled(utiqConfig)
-                ? [mkInitStep('utiq', ctx => loadUtiq(utiqConfig, ctx))]
+                ? [mkConfigureStepOncePerRequestAdsCycle('utiq', ctx => loadUtiq(utiqConfig, ctx))]
                 : [];
         },
         prepareRequestAdsSteps__() {

package/lib/gen/packageJson.js

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

package/package.json

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