exclusions support for header, banner, epic and gutter components

.changeset/small-weeks-call.md

@@ -0,0 +1,5 @@
+---
+'@guardian/support-dotcom-components': patch
+---
+
+optional sectionId and tagsId properties added to HeaderTargeting model

cdk/lib/dotcom-components.ts

@@ -263,6 +263,7 @@ sudo amazon-cloudwatch-agent-ctl -a fetch-config -m ec2 -c file:/opt/aws/amazon-
 					`${this.stage}/banner-deploy/*`,
 					`${this.stage}/channel-switches.json`,
 					`${this.stage}/configured-amounts-v3.json`,
+					`${this.stage}/exclusions.json`,
 					`${this.stage}/guardian-weekly-propensity-test/*`,
 					`PROD/auxia-credentials.json`,
 				],

src/server/api/bannerRouter.ts

@@ -11,6 +11,7 @@ import type {
     Tracking,
 } from '../../shared/types';
 import { channelFromBannerChannel } from '../../shared/types';
+import type { ExclusionSettings } from '../channelExclusions';
 import type { ChannelSwitches } from '../channelSwitches';
 import type { Auxia, GetTreatmentsAttributes } from '../lib/auxia';
 import { getChoiceCardsSettings } from '../lib/choiceCards/choiceCards';
@@ -31,7 +32,7 @@ import type { BannerDeployTimesProvider } from '../tests/banners/bannerDeployTim
 import { selectBannerTest } from '../tests/banners/bannerSelection';
 import { getDesignForVariant } from '../tests/banners/channelBannerTests';
 import type { Debug } from '../tests/epics/epicSelection';
-import { shouldSuppressBannerForSectionDate } from '../utils/bannerSectionSuppression';
+import { inExclusions } from '../utils/channelExclusionsMatcher';
 import type { ValueProvider } from '../utils/valueReloader';
 
 interface BannerDataResponse {
@@ -58,6 +59,7 @@ export const buildBannerRouter = (
     mParticle: MParticle,
     okta: Okta,
     auxia: Auxia,
+    channelExclusions: ValueProvider<ExclusionSettings>,
 ): Router => {
     const router = Router();
 
@@ -73,7 +75,7 @@ export const buildBannerRouter = (
     ): Promise<BannerDataResponse> => {
         const { enableBanners, enableHardcodedBannerTests, enableScheduledBannerDeploys } =
             channelSwitches.get();
-        const now = new Date();
+        const channelExclusionsData = channelExclusions.get();
 
         if (!enableBanners) {
             return {};
@@ -83,7 +85,7 @@ export const buildBannerRouter = (
             return {};
         }
 
-        if (shouldSuppressBannerForSectionDate(targeting.sectionId, now)) {
+        if (inExclusions(targeting, channelExclusionsData.banner)) {
             return {};
         }
 
@@ -96,7 +98,7 @@ export const buildBannerRouter = (
             enableScheduledDeploys: enableScheduledBannerDeploys,
             banditData: banditData.get(),
             getMParticleProfile,
-            now,
+            now: new Date(),
             forcedTestVariant: params.force,
             checkAuxiaSuppression,
         });

src/server/api/epicRouter.ts

@@ -12,6 +12,7 @@ import type {
     Tracking,
     WeeklyArticleLog,
 } from '../../shared/types';
+import type { ExclusionSettings } from '../channelExclusions';
 import type { ChannelSwitches } from '../channelSwitches';
 import { getChoiceCardsSettings } from '../lib/choiceCards/choiceCards';
 import { getDeviceType } from '../lib/deviceType';
@@ -31,6 +32,7 @@ import { selectAmountsTestVariant } from '../selection/ab';
 import type { BanditData } from '../selection/banditData';
 import type { Debug } from '../tests/epics/epicSelection';
 import { findForcedTestAndVariant, findTestAndVariant } from '../tests/epics/epicSelection';
+import { inExclusions } from '../utils/channelExclusionsMatcher';
 import { logWarn } from '../utils/logging';
 import type { ValueProvider } from '../utils/valueReloader';
 
@@ -61,6 +63,7 @@ export const buildEpicRouter = (
     promotions: ValueProvider<PromotionsCache>,
     mParticle: MParticle,
     okta: Okta,
+    channelExclusions: ValueProvider<ExclusionSettings>,
 ): Router => {
     const router = Router();
 
@@ -92,6 +95,7 @@ export const buildEpicRouter = (
         getMParticleProfile: () => Promise<MParticleProfile | undefined>,
     ): Promise<EpicDataResponse> => {
         const { enableEpics, enableSuperMode, enableHardcodedEpicTests } = channelSwitches.get();
+        const channelExclusionsData = channelExclusions.get();
         if (!enableEpics) {
             return {};
         }
@@ -100,6 +104,15 @@ export const buildEpicRouter = (
             return {};
         }
 
+        if (
+            inExclusions(
+                { ...targeting, tagIds: targeting.tags.map(({ id }) => id) },
+                channelExclusionsData.epic,
+            )
+        ) {
+            return {};
+        }
+
         const targetingMvtId = targeting.mvtId ?? 1;
 
         const tests =

src/server/api/gutterRouter.ts

@@ -7,6 +7,7 @@ import type {
     TestTracking,
     Tracking,
 } from '../../shared/types';
+import type { ExclusionSettings } from '../channelExclusions';
 import type { ChannelSwitches } from '../channelSwitches';
 import { getDeviceType } from '../lib/deviceType';
 import { baseUrl } from '../lib/env';
@@ -16,6 +17,7 @@ import { pageIdIsExcluded } from '../lib/targeting';
 import { buildGutterCampaignCode } from '../lib/tracking';
 import { bodyContainsAllFields } from '../middleware';
 import { selectGutterTest } from '../tests/gutters/gutterSelection';
+import { inExclusions } from '../utils/channelExclusionsMatcher';
 import type { ValueProvider } from '../utils/valueReloader';
 
 interface GutterDataResponse {
@@ -31,6 +33,7 @@ interface GutterDataResponse {
 export const buildGutterRouter = (
     channelSwitches: ValueProvider<ChannelSwitches>,
     tests: ValueProvider<GutterTest[]>,
+    channelExclusions: ValueProvider<ExclusionSettings>,
 ): Router => {
     const router = Router();
 
@@ -41,6 +44,7 @@ export const buildGutterRouter = (
         req: express.Request,
     ): GutterDataResponse => {
         const { enableGutterLiveblogs } = channelSwitches.get();
+        const channelExclusionsData = channelExclusions.get();
         if (!enableGutterLiveblogs) {
             return {};
         }
@@ -49,6 +53,10 @@ export const buildGutterRouter = (
             return {};
         }
 
+        if (inExclusions(targeting, channelExclusionsData.gutterAsk)) {
+            return {};
+        }
+
         const testSelection = selectGutterTest(
             targeting,
             tests.get(),

src/server/api/headerRouter.ts

@@ -7,6 +7,7 @@ import type {
     TestTracking,
     Tracking,
 } from '../../shared/types';
+import type { ExclusionSettings } from '../channelExclusions';
 import type { ChannelSwitches } from '../channelSwitches';
 import { getDeviceType } from '../lib/deviceType';
 import { baseUrl } from '../lib/env';
@@ -16,6 +17,7 @@ import { getQueryParams } from '../lib/params';
 import type { Params } from '../lib/params';
 import { bodyContainsAllFields } from '../middleware';
 import { selectHeaderTest } from '../tests/headers/headerSelection';
+import { inExclusions } from '../utils/channelExclusionsMatcher';
 import type { ValueProvider } from '../utils/valueReloader';
 
 interface HeaderDataResponse {
@@ -33,6 +35,7 @@ export const buildHeaderRouter = (
     tests: ValueProvider<HeaderTest[]>,
     mParticle: MParticle,
     okta: Okta,
+    channelExclusions: ValueProvider<ExclusionSettings>,
 ): Router => {
     const router = Router();
 
@@ -44,9 +47,15 @@ export const buildHeaderRouter = (
         getMParticleProfile: () => Promise<MParticleProfile | undefined>,
     ): Promise<HeaderDataResponse> => {
         const { enableHeaders } = channelSwitches.get();
+        const channelExclusionsData = channelExclusions.get();
         if (!enableHeaders) {
             return {};
         }
+
+        if (inExclusions(targeting, channelExclusionsData.header)) {
+            return {};
+        }
+
         const testSelection = await selectHeaderTest(
             targeting,
             tests.get(),

src/server/channelExclusions.ts

@@ -0,0 +1,52 @@
+import { isProd } from './lib/env';
+import { logWarn } from './utils/logging';
+import { fetchS3Data } from './utils/S3';
+import type { ValueReloader } from './utils/valueReloader';
+import { buildReloader } from './utils/valueReloader';
+
+export interface DateRange {
+    start: string; // ISO date "YYYY-MM-DD", inclusive
+    end: string; // ISO date "YYYY-MM-DD", inclusive
+}
+
+export interface ExclusionRule {
+    name: string;
+    sectionIds?: string[];
+    tagIds?: string[];
+    dateRange?: DateRange;
+    contentTypes?: Array<'Fronts' | 'Articles'>;
+}
+
+export interface ChannelExclusions {
+    rules: ExclusionRule[];
+}
+
+export interface ExclusionSettings {
+    epic?: ChannelExclusions;
+    banner?: ChannelExclusions;
+    gutterAsk?: ChannelExclusions;
+    header?: ChannelExclusions;
+}
+
+const emptyExclusions: ExclusionSettings = {};
+
+const getExclusions = async (): Promise<ExclusionSettings> => {
+    try {
+        const data = await fetchS3Data(
+            'support-admin-console',
+            `${isProd ? 'PROD' : 'CODE'}/exclusions.json`,
+        );
+        const parsed = JSON.parse(data) as ExclusionSettings;
+        return parsed;
+    } catch (error) {
+        logWarn(
+            `Failed to load exclusions config from S3: ${String(error)}. Proceeding with no exclusions.`,
+        );
+        return emptyExclusions;
+    }
+};
+
+const buildChannelExclusionsReloader = (): Promise<ValueReloader<ExclusionSettings>> =>
+    buildReloader(getExclusions, 60);
+
+export { buildChannelExclusionsReloader };

src/server/server.ts

@@ -8,6 +8,7 @@ import { buildEpicRouter } from './api/epicRouter';
 import { buildGutterRouter } from './api/gutterRouter';
 import { buildHeaderRouter } from './api/headerRouter';
 import { buildTickerRouter } from './api/tickerRouter';
+import { buildChannelExclusionsReloader } from './channelExclusions';
 import { buildChannelSwitchesReloader } from './channelSwitches';
 import { buildChoiceCardAmountsReloader } from './choiceCardAmounts';
 import { Auxia } from './lib/auxia';
@@ -88,6 +89,7 @@ const buildApp = async (): Promise<Express> => {
         gutterLiveblogTests,
         productCatalog,
         promotions,
+        channelExclusions,
     ] = await Promise.all([
         buildChannelSwitchesReloader(),
         buildSuperModeArticlesReloader(),
@@ -102,6 +104,7 @@ const buildApp = async (): Promise<Express> => {
         buildGutterLiveblogTestsReloader(),
         buildProductCatalogReloader(),
         buildPromotionsReloader(),
+        buildChannelExclusionsReloader(),
     ]);
 
     const banditData = await buildBanditDataReloader(articleEpicTests, bannerTests);
@@ -129,6 +132,7 @@ const buildApp = async (): Promise<Express> => {
             promotions,
             mParticle,
             okta,
+            channelExclusions,
         ),
     );
     app.use(
@@ -145,13 +149,14 @@ const buildApp = async (): Promise<Express> => {
             mParticle,
             okta,
             auxia,
+            channelExclusions,
         ),
     );
-    app.use(buildHeaderRouter(channelSwitches, headerTests, mParticle, okta));
+    app.use(buildHeaderRouter(channelSwitches, headerTests, mParticle, okta, channelExclusions));
 
     app.use(buildAuxiaProxyRouter(channelSwitches, auxiaConfig));
 
-    app.use(buildGutterRouter(channelSwitches, gutterLiveblogTests));
+    app.use(buildGutterRouter(channelSwitches, gutterLiveblogTests, channelExclusions));
 
     app.use(buildTickerRouter(tickerData));