@highfivve/ad-tag 5.8.33 → 5.9.0

package/lib/ads/moduleConfigOverrides.js

@@ -0,0 +1,8 @@
+export const resolveModuleConfig = (base, isLabelConditionMet) => {
+    const { overrides = [], ...defaultConfig } = base;
+    const matchedOverrideIndex = overrides.findIndex(isLabelConditionMet);
+    const match = overrides[matchedOverrideIndex];
+    return match
+        ? { config: match.config, matchedOverrideIndex, matchedCondition: match }
+        : { config: defaultConfig, matchedOverrideIndex: -1 };
+};

package/lib/ads/modules/generic-skin/index.js

@@ -16,6 +16,32 @@ export const createSkin = () => {
     let skinModuleConfig = null;
     let bidsBackHandler = [];
     const config__ = () => skinModuleConfig;
+    const getSkinBids = (config, bidResponses) => {
+        const skinBidResponse = bidResponses[config.skinAdSlotDomId];
+        const isSkinBid = (bid) => {
+            const oneFilterApplied = config.formatFilter.some(filter => {
+                switch (filter.bidder) {
+                    case '*':
+                        return true;
+                    case 'gumgum':
+                        return (bid.bidder === prebidjs.GumGum &&
+                            (filter.auid === undefined ||
+                                (typeof bid.ad !== 'string' && bid.ad.auid === filter.auid)));
+                    default:
+                        return bid.bidder === filter.bidder;
+                }
+            });
+            return bid.cpm > 0 && oneFilterApplied;
+        };
+        return skinBidResponse
+            ?
+                skinBidResponse.bids.filter(isSkinBid).sort((bid1, bid2) => bid2.cpm - bid1.cpm)
+            : [];
+    };
+    const getHighestSkinBidCpm = (config, bidResponses) => {
+        const skinBids = getSkinBids(config, bidResponses);
+        return skinBids.length > 0 ? skinBids[0].cpm : null;
+    };
     const getConfigEffect = (config, bidResponses, log) => {
         const skinBidResponse = bidResponses[config.skinAdSlotDomId];
         const isSkinBid = (bid) => {
@@ -54,12 +80,29 @@ export const createSkin = () => {
         }
         return skinBids.length > 0 ? "BlockOtherSlots" : "NoBlocking";
     };
-    const selectConfig = (skinModuleConfig, bidResponses, log) => skinModuleConfig.configs
-        .map(config => ({
-        skinConfig: config,
-        configEffect: getConfigEffect(config, bidResponses, log)
-    }))
-        .find(({ configEffect }) => configEffect !== "NoBlocking");
+    const selectConfig = (skinModuleConfig, bidResponses, log) => {
+        const configEvaluations = skinModuleConfig.configs.map(config => ({
+            skinConfig: config,
+            configEffect: getConfigEffect(config, bidResponses, log),
+            highestSkinCpm: getHighestSkinBidCpm(config, bidResponses)
+        }));
+        const matchingConfigs = configEvaluations.filter(({ configEffect }) => configEffect !== "NoBlocking");
+        const compareWithOtherSkinsConfigs = matchingConfigs.filter(({ skinConfig }) => skinConfig.compareWithOtherSkins);
+        if (compareWithOtherSkinsConfigs.length > 1) {
+            return compareWithOtherSkinsConfigs.reduce((selectedConfig, currentConfig) => {
+                if (selectedConfig.highestSkinCpm === null ||
+                    (currentConfig.highestSkinCpm !== null &&
+                        currentConfig.highestSkinCpm > selectedConfig.highestSkinCpm)) {
+                    return currentConfig;
+                }
+                return selectedConfig;
+            });
+        }
+        const fallbackConfig = matchingConfigs[0];
+        return fallbackConfig
+            ? { skinConfig: fallbackConfig.skinConfig, configEffect: fallbackConfig.configEffect }
+            : undefined;
+    };
     const destroyAdSlot = (slotDefinitions, gWindow) => (adSlotDomId) => {
         const adSlots = slotDefinitions
             .map(slot => slot.adSlot)

package/lib/ads/moli.js

@@ -9,6 +9,7 @@ import * as adUnitPath from './adUnitPath';
 import { extractTopPrivateDomainFromHostname } from '../util/extractTopPrivateDomainFromHostname';
 import { detectGeoFromBrowser } from '../util/detectGeoFromTimezone';
 import { createLabelConfigService } from './labelConfigService';
+import { resolveModuleConfig } from './moduleConfigOverrides';
 import { allowRefreshAdSlot, allowRequestAds } from './spa';
 import { QueryParameters } from 'ad-tag/util/queryParameters';
 import { BrowserStorageKeys } from 'ad-tag/util/browserStorageKeys';
@@ -244,21 +245,31 @@ export const createMoliTag = (window) => {
                 getLogger(state.runtimeConfig, window).debug('MoliGlobal', 'configure modules', state.config.modules ?? {});
                 const labelService = createLabelConfigService(state.config?.labelSizeConfig || [], state.runtimeConfig.labels, window);
                 modules
-                    .filter(module => {
+                    .map(module => {
                     const moduleName = module.name;
-                    const moduleConfig = state.config?.modules?.[moduleName];
-                    if (moduleConfig?.labelCondition) {
-                        const areLabelConditionsMet = labelService.isLabelConditionMet(moduleConfig.labelCondition);
-                        if (!areLabelConditionsMet) {
-                            getLogger(state.runtimeConfig, window).debug('MoliGlobal', `skipping configuration of ${module.moduleType} module ${moduleName} due to label condition not met.`);
-                            return false;
-                        }
+                    const base = state.config?.modules?.[moduleName];
+                    if (!base) {
+                        return null;
+                    }
+                    const { config: effectiveConfig, matchedOverrideIndex, matchedCondition } = resolveModuleConfig(base, labelService.isLabelConditionMet);
+                    if (matchedOverrideIndex >= 0) {
+                        getLogger(state.runtimeConfig, window).debug('MoliGlobal', `module ${moduleName}: applying config override #${matchedOverrideIndex}`, matchedCondition);
                     }
-                    return true;
+                    if (effectiveConfig.labelCondition &&
+                        !labelService.isLabelConditionMet(effectiveConfig.labelCondition)) {
+                        getLogger(state.runtimeConfig, window).debug('MoliGlobal', `skipping configuration of ${module.moduleType} module ${moduleName} due to label condition not met.`);
+                        return null;
+                    }
+                    const resolvedModulesConfig = {
+                        ...state.config?.modules,
+                        [moduleName]: effectiveConfig
+                    };
+                    return { module, resolvedModulesConfig };
                 })
-                    .forEach(module => {
+                    .filter((entry) => entry !== null)
+                    .forEach(({ module, resolvedModulesConfig }) => {
                     try {
-                        module.configure__(state.config?.modules ?? {});
+                        module.configure__(resolvedModulesConfig);
                         getLogger(state.runtimeConfig, window).debug('MoliGlobal', `configure ${module.moduleType} module ${module.name}`, module.config__());
                         state.runtimeConfig.adPipelineConfig.initSteps.push(...module.initSteps__());
                         state.runtimeConfig.adPipelineConfig.configureSteps.push(...module.configureSteps__());

package/lib/gen/packageJson.js

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

package/package.json

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