TW-1364 Implement returning different ads data depending on web exten…

src/advertising/external-ads.ts

@@ -0,0 +1,212 @@
+import { objectStorageMethodsFactory, redisClient } from '../redis';
+import { isDefined } from '../utils/helpers';
+
+/** Style properties names that are likely to be unnecessary for banners are skipped */
+export const stylePropsNames = [
+  'align-content',
+  'align-items',
+  'align-self',
+  'alignment-baseline',
+  'aspect-ratio',
+  'background',
+  'border',
+  'border-radius',
+  'bottom',
+  'box-shadow',
+  'box-sizing',
+  'display',
+  'flex',
+  'flex-basis',
+  'flex-direction',
+  'flex-flow',
+  'flex-grow',
+  'flex-shrink',
+  'flex-wrap',
+  'float',
+  'height',
+  'justify-content',
+  'justify-items',
+  'justify-self',
+  'left',
+  'margin',
+  'margin-block',
+  'margin-block-end',
+  'margin-block-start',
+  'margin-bottom',
+  'margin-inline',
+  'margin-inline-end',
+  'margin-inline-start',
+  'margin-left',
+  'margin-right',
+  'margin-top',
+  'max-block-size',
+  'max-height',
+  'max-inline-size',
+  'max-width',
+  'min-block-size',
+  'min-height',
+  'min-inline-size',
+  'min-width',
+  'opacity',
+  'overflow',
+  'overflow-anchor',
+  'overflow-wrap',
+  'overflow-x',
+  'overflow-y',
+  'padding',
+  'padding-block',
+  'padding-block-end',
+  'padding-block-start',
+  'padding-bottom',
+  'padding-inline',
+  'padding-inline-end',
+  'padding-inline-start',
+  'padding-left',
+  'padding-right',
+  'padding-top',
+  'position',
+  'right',
+  'text-align',
+  'top',
+  'vertical-align',
+  'visibility',
+  'width',
+  'z-index',
+  'background-image',
+  'background-clip',
+  'background-color'
+];
+export type StylePropName = (typeof stylePropsNames)[number];
+
+interface AdStylesOverrides {
+  parentDepth: number;
+  style: Record<StylePropName, string>;
+}
+
+interface ExtVersionConstraints {
+  firstExtVersion?: string;
+  lastExtVersion?: string;
+}
+
+export interface AdPlacesRule extends ExtVersionConstraints {
+  urlRegexes: string[];
+  selector: {
+    isMultiple: boolean;
+    cssString: string;
+    parentDepth: number;
+    shouldUseDivWrapper: boolean;
+    divWrapperStyle?: Record<StylePropName, string>;
+  };
+  stylesOverrides?: AdStylesOverrides[];
+  shouldHideOriginal?: boolean;
+}
+
+export interface PermanentAdPlacesRule extends ExtVersionConstraints {
+  urlRegexes: string[];
+  adSelector: {
+    isMultiple: boolean;
+    cssString: string;
+    parentDepth: number;
+  };
+  parentSelector: {
+    isMultiple: boolean;
+    cssString: string;
+    parentDepth: number;
+  };
+  insertionIndex?: number;
+  insertBeforeSelector?: string;
+  insertAfterSelector?: string;
+  insertionsCount?: number;
+  shouldUseDivWrapper: boolean;
+  elementStyle?: Record<StylePropName, string>;
+  divWrapperStyle?: Record<StylePropName, string>;
+  elementToMeasureSelector?: string;
+  stylesOverrides?: AdStylesOverrides[];
+  shouldHideOriginal?: boolean;
+}
+
+export interface AdProvidersByDomainRule extends ExtVersionConstraints {
+  urlRegexes: string[];
+  providers: string[];
+}
+
+export interface AdProviderSelectorsRule extends ExtVersionConstraints {
+  selectors: string[];
+}
+
+export interface AdProviderForAllSitesRule extends ExtVersionConstraints {
+  providers: string[];
+}
+
+const AD_PLACES_RULES_KEY = 'slise_ad_places_rules';
+const AD_PROVIDERS_BY_SITES_KEY = 'slise_ad_providers_by_sites';
+const AD_PROVIDERS_ALL_SITES_KEY = 'slise_ad_providers_all_sites';
+const SLISE_AD_PROVIDERS_LIST_KEY = 'slise_ad_providers_list';
+const AD_PROVIDERS_LIST_KEY = 'ad_providers_list';
+const PERMANENT_AD_PLACES_RULES_KEY = 'permanent_slise_ad_places_rules';
+const PERMANENT_NATIVE_AD_PLACES_RULES_KEY = 'permanent_native_ad_places_rules';
+
+export const adPlacesRulesMethods = objectStorageMethodsFactory<AdPlacesRule[]>(AD_PLACES_RULES_KEY, []);
+
+export const adProvidersByDomainRulesMethods = objectStorageMethodsFactory<AdProvidersByDomainRule[]>(
+  AD_PROVIDERS_BY_SITES_KEY,
+  []
+);
+
+/** @deprecated */
+export const adProvidersMethodsLegacy = objectStorageMethodsFactory<string[]>(SLISE_AD_PROVIDERS_LIST_KEY, []);
+
+export const adProvidersMethods = objectStorageMethodsFactory<AdProviderSelectorsRule[]>(AD_PROVIDERS_LIST_KEY, []);
+
+export const permanentAdPlacesMethods = objectStorageMethodsFactory<PermanentAdPlacesRule[]>(
+  PERMANENT_AD_PLACES_RULES_KEY,
+  []
+);
+
+export const permanentNativeAdPlacesMethods = objectStorageMethodsFactory<PermanentAdPlacesRule[]>(
+  PERMANENT_NATIVE_AD_PLACES_RULES_KEY,
+  []
+);
+
+export const getAdProvidersForAllSites = async () => redisClient.smembers(AD_PROVIDERS_ALL_SITES_KEY);
+
+export const addAdProvidersForAllSites = async (providers: string[]) =>
+  redisClient.sadd(AD_PROVIDERS_ALL_SITES_KEY, ...providers);
+
+export const removeAdProvidersForAllSites = async (providers: string[]) =>
+  redisClient.srem(AD_PROVIDERS_ALL_SITES_KEY, ...providers);
+
+const compareVersions = (a: string, b: string) => {
+  const [aMajor = 0, aMinor = 0, aPatch = 0] = a.split('.').map(Number);
+  const [bMajor = 0, bMinor = 0, bPatch = 0] = b.split('.').map(Number);
+
+  if (aMajor !== bMajor) {
+    return aMajor - bMajor;
+  }
+
+  if (aMinor !== bMinor) {
+    return aMinor - bMinor;
+  }
+
+  return aPatch - bPatch;
+};
+
+export const filterByVersion = <T extends ExtVersionConstraints>(rules: T[], version?: string) => {
+  if (!isDefined(version)) {
+    return rules.filter(
+      ({ firstExtVersion, lastExtVersion }) => !isDefined(firstExtVersion) && !isDefined(lastExtVersion)
+    );
+  }
+
+  return rules.filter(({ firstExtVersion, lastExtVersion }) => {
+    if (isDefined(firstExtVersion) && compareVersions(firstExtVersion, version) > 0) {
+      return false;
+    }
+
+    if (isDefined(lastExtVersion) && compareVersions(lastExtVersion, version) < 0) {
+      return false;
+    }
+
+    return true;
+  });
+};