Don't serve ab tests set to off (#14684)

* Don't serve ab tests set to off

* make test more explicit

* don't upload inactive tests to fastly

* remove expiry method

* metrics

* frontend

Author: Jakeii

ab-testing/README.md

@@ -63,6 +63,10 @@ To add a test where there is not enough space in the default audience space (`A`
 
 For example if there are already 3 25% tests in space `A` totalling 75%, and you want to run a 50% test, you can set the `audienceSpace` to `B` to allow this test to overlap with the existing tests.
 
+### Test Status
+
+Tests can be set to `ON` or `OFF` using the `status` field. Only tests with status `ON` will be validated and deployed.
+
 ## How it works
 
 The AB testing framework uses Deno to run scripts that validate and deploy the tests. The `deno.json` file contains the tasks that can be run, such as `validate`, `deploy`, and `build`.

ab-testing/abTest.ts

@@ -19,4 +19,8 @@ import type { ABTest } from './types';
  * - 100% Test	variant		MVT 500-999
  */
 
-export const ABTests: ABTest[] = [];
+const ABTests: ABTest[] = [];
+
+const activeABtests = ABTests.filter((test) => test.status === 'ON');
+
+export { ABTests as allABTests, activeABtests };

ab-testing/frontend/src/routes/+page.svelte

@@ -1,5 +1,5 @@
 <script lang="ts">
-	import { ABTests } from '../../../abTest';
+	import { allABTests, activeABtests } from '../../../abTest';
 	import Table from '$lib/components/TableFixed.svelte';
 	import AudienceBreakdown from '$lib/components/AudienceBreakdown.svelte';
 </script>
@@ -31,8 +31,8 @@
 	</p>
 </section>
 <section>
-	<AudienceBreakdown tests={ABTests} />
-	<Table tests={ABTests} />
+	<AudienceBreakdown tests={activeABtests} />
+	<Table tests={allABTests} />
 </section>
 
 <style>

ab-testing/index.ts

@@ -1,4 +1,4 @@
 // @ts-ignore - extension is required to import this as a package in DCR
-import { ABTests } from './abTest.ts';
+import { ABTests, activeABtests } from './abTest.ts';
 
-export { ABTests };
+export { ABTests, activeABtests };

ab-testing/scripts/build/index.ts

@@ -1,10 +1,10 @@
-import { ABTests } from '../../abTest.ts';
 import { getMVTGroupsFromDictionary } from '../lib/fastly-api.ts';
 import { buildABTestGroupKeyValues } from './build-ab-tests-dict.ts';
 import { parseArgs } from 'jsr:@std/cli/parse-args';
 import { calculateAllSpaceUpdates } from './calculate-mvt-updates.ts';
 import { parseMVTValue, stringifyMVTValue } from '../lib/fastly-subfield.ts';
 import { dirname } from 'jsr:@std/path';
+import { activeABtests } from '../../abTest.ts';
 
 const flags = parseArgs(Deno.args, {
 	string: ['mvts', 'ab-tests'],
@@ -26,9 +26,9 @@ const mvtGroups = new Map(
 	}),
 );
 
-const abTestGroupKeyValues = buildABTestGroupKeyValues(ABTests);
+const abTestGroupKeyValues = buildABTestGroupKeyValues(activeABtests);
 
-const mvtIdKeyValues = calculateAllSpaceUpdates(mvtGroups, ABTests);
+const mvtIdKeyValues = calculateAllSpaceUpdates(mvtGroups, activeABtests);
 
 const mvtDictArray = Array.from(
 	mvtIdKeyValues.entries().map(([key, value]) => ({

ab-testing/scripts/validation/index.ts

@@ -1,5 +1,5 @@
-import { ABTests } from '../../abTest.ts';
 import { ABTest } from '../../types.ts';
+import { activeABtests } from '../../abTest.ts';
 import { enoughSpace } from './enoughSpace.ts';
 import { limitServerSideTests } from './limitServerSide.ts';
 import { uniqueName } from './uniqueName.ts';
@@ -19,7 +19,7 @@ function validateTests(testList: ABTest[]) {
 }
 
 try {
-	validateTests(ABTests);
+	validateTests(activeABtests);
 	console.log('AB test validations passed');
 } catch (err) {
 	const error = err as Error;

ab-testing/scripts/validation/validExpiration.ts

@@ -12,7 +12,7 @@ export function allExpirationsValid(tests: ABTest[]): boolean {
 		throw new Error(
 			`${
 				test.name
-			} has an expiration date in the past: ${expires.toISOString()}, has it expired?`,
+			} has an expiration date in the past: ${expires.toISOString()}, has it expired? If it doesn't belong to you or your team, you can set the status to OFF for now.`,
 		);
 	});
 }

dotcom-rendering/src/components/Metrics.importable.tsx

@@ -1,5 +1,5 @@
 import type { ABTest, ABTestAPI } from '@guardian/ab-core';
-import { ABTests } from '@guardian/ab-testing';
+import { activeABtests } from '@guardian/ab-testing';
 import {
 	bypassCommercialMetricsSampling,
 	EventTimer,
@@ -33,7 +33,7 @@ const clientSideTestsToForceMetrics: ABTest[] = [
 ];
 
 const shouldCollectMetricsForBetaTests = (userTestParticipations: string[]) => {
-	const userParticipationConfigs = ABTests.filter((test) =>
+	const userParticipationConfigs = activeABtests.filter((test) =>
 		userTestParticipations.includes(test.name),
 	);
 	return userParticipationConfigs.some(