Rename EditorialTestData to FrontEditorialTestData in enahanceCards

Author: emma-imber

dotcom-rendering/src/model/enhanceCards.test.ts

@@ -11,7 +11,7 @@ import {
 	decideArticleMedia,
 	decideReplacementMedia,
 	getActiveMediaAtom,
-	getEditorialTestData,
+	getFrontEditorialTestData,
 	getMediaMetadata,
 } from './enhanceCards';
 
@@ -535,7 +535,7 @@ describe('Enhance Cards', () => {
 		});
 	});
 
-	describe('getEditorialTestData', () => {
+	describe('getFrontEditorialTestData', () => {
 		const cardWithNoEditorialTest = {
 			properties: {
 				isBreaking: false,
@@ -669,7 +669,7 @@ describe('Enhance Cards', () => {
 
 		it('returns undefined if no editorial test exists on the card, page is not in allowed fronts list, and user is not in a test bucket', () => {
 			expect(
-				getEditorialTestData(
+				getFrontEditorialTestData(
 					cardWithNoEditorialTest,
 					{},
 					true,
@@ -680,7 +680,7 @@ describe('Enhance Cards', () => {
 
 		it('returns undefined if editorial test exists and page is in allowed fronts list, but user is not in a test bucket', () => {
 			expect(
-				getEditorialTestData(
+				getFrontEditorialTestData(
 					cardWithEditorialTest,
 					{},
 					true,
@@ -691,7 +691,7 @@ describe('Enhance Cards', () => {
 
 		it('returns undefined if user is in a test bucket and page is in allowed fronts list, but editorial test does not exist', () => {
 			expect(
-				getEditorialTestData(
+				getFrontEditorialTestData(
 					cardWithNoEditorialTest,
 					{
 						'fronts-and-curation-editorial-test': 'a',
@@ -704,7 +704,7 @@ describe('Enhance Cards', () => {
 
 		it('returns undefined if editorial test exists and user is in a test bucket, but page is not in allowed fronts list', () => {
 			expect(
-				getEditorialTestData(
+				getFrontEditorialTestData(
 					cardWithEditorialTest,
 					{
 						'fronts-and-curation-editorial-test': 'a',
@@ -717,7 +717,7 @@ describe('Enhance Cards', () => {
 
 		it('returns undefined if editorial test exists, page is in allowed fronts list, user is in a variant bucket, but the feature switch is turned off ', () => {
 			expect(
-				getEditorialTestData(
+				getFrontEditorialTestData(
 					cardWithEditorialTest,
 					{
 						'fronts-and-curation-editorial-test': 'a',
@@ -730,7 +730,7 @@ describe('Enhance Cards', () => {
 
 		it('returns headline A & test uuid if editorial test exists, page is in allowed fronts list, and user is in bucket A', () => {
 			expect(
-				getEditorialTestData(
+				getFrontEditorialTestData(
 					cardWithEditorialTest,
 					{
 						'fronts-and-curation-editorial-test': 'a',
@@ -743,7 +743,7 @@ describe('Enhance Cards', () => {
 
 		it('returns headline B & test uuid if editorial test exists, page is in allowed fronts list, and user is in bucket B', () => {
 			expect(
-				getEditorialTestData(
+				getFrontEditorialTestData(
 					cardWithEditorialTest,
 					{
 						'fronts-and-curation-editorial-test': 'b',
@@ -756,7 +756,7 @@ describe('Enhance Cards', () => {
 
 		it('returns undefined if the bucket name does not match a variant meta id', () => {
 			expect(
-				getEditorialTestData(
+				getFrontEditorialTestData(
 					cardWithEditorialTest,
 					{
 						'fronts-and-curation-editorial-test': 'c',
@@ -769,7 +769,7 @@ describe('Enhance Cards', () => {
 
 		it('returns undefined if the variant headline is undefined', () => {
 			expect(
-				getEditorialTestData(
+				getFrontEditorialTestData(
 					cardWithEditorialTestWithUndefinedVariantMeta,
 					{
 						'fronts-and-curation-editorial-test': 'a',
@@ -782,7 +782,7 @@ describe('Enhance Cards', () => {
 
 		it('returns undefined if an editorial test has expired', () => {
 			expect(
-				getEditorialTestData(
+				getFrontEditorialTestData(
 					cardWithExpiredEditorialTest,
 					{
 						'fronts-and-curation-editorial-test': 'a',
@@ -795,7 +795,7 @@ describe('Enhance Cards', () => {
 
 		it('returns undefined if an editorial test has been manually ended', () => {
 			expect(
-				getEditorialTestData(
+				getFrontEditorialTestData(
 					cardWithManuallyEndedEditorialTest,
 					{
 						'fronts-and-curation-editorial-test': 'a',
@@ -808,7 +808,7 @@ describe('Enhance Cards', () => {
 
 		it('returns the variant headline & test uuid if an editorial test is present on a sublink', () => {
 			expect(
-				getEditorialTestData(
+				getFrontEditorialTestData(
 					cardWithSublinkWithEditorialTest
 						.supportingContent[0] as FESupportingContent,
 					{
@@ -822,7 +822,7 @@ describe('Enhance Cards', () => {
 
 		it('returns undefined for a sublink if an editorial test is expired on a sublink', () => {
 			expect(
-				getEditorialTestData(
+				getFrontEditorialTestData(
 					cardWithSublinkWithExpiredEditorialTest
 						.supportingContent[0] as FESupportingContent,
 					{

dotcom-rendering/src/model/enhanceCards.ts

@@ -203,7 +203,7 @@ const decideVideoAtomImage = (
  * Checks if an editorial test is active by making sure it has not been manually ended,
  * that it has a valid expiry date, and that the expiry date is in the future
  */
-const isActiveEditorialTest = (test: FrontEditorialTest) =>
+const isActiveFrontEditorialTest = (test: FrontEditorialTest) =>
 	!test.hasManuallyEndedOnThisTrail &&
 	!!test.expiryDate &&
 	test.expiryDate > Date.now();
@@ -212,13 +212,13 @@ const isActiveEditorialTest = (test: FrontEditorialTest) =>
  * Looks through a list of editorial tests to see if there is an active test. If no active
  * test is found, return undefined
  */
-const findActiveEditorialTest = (
+const findActiveFrontEditorialTest = (
 	tests: FrontEditorialTest[] | undefined,
 ): FrontEditorialTest | undefined => {
-	return tests?.find((test) => isActiveEditorialTest(test));
+	return tests?.find((test) => isActiveFrontEditorialTest(test));
 };
 
-type EditorialTestData = {
+type FrontEditorialTestData = {
 	headline: string;
 	uuid: string;
 };
@@ -228,24 +228,24 @@ type EditorialTestData = {
  * the the testing switch is enabled, the page is in the test bucket, the test can run on the given front,
  * and that a valid variant headline is defined before returning the variant headline and test UUID.
  */
-export const getEditorialTestData = (
+export const getFrontEditorialTestData = (
 	faciaCard: FEFrontCard | FESupportingContent,
 	serverSideABTests: Record<string, string>,
 	isEditorialABTestingEnabled: boolean,
 	pageId?: string,
-): EditorialTestData | undefined => {
-	const activeEditorialTest = findActiveEditorialTest(
+): FrontEditorialTestData | undefined => {
+	const activeFrontEditorialTest = findActiveFrontEditorialTest(
 		faciaCard.properties.tests,
 	);
 
 	// don't return data if there is no active test on the card or editorial testing is switched off
-	if (!activeEditorialTest || !isEditorialABTestingEnabled) {
+	if (!activeFrontEditorialTest || !isEditorialABTestingEnabled) {
 		return undefined;
 	}
 
 	const testCanRunOnPage =
 		!isUndefined(pageId) &&
-		activeEditorialTest.frontsThisTestCanRunOn.includes(pageId);
+		activeFrontEditorialTest.frontsThisTestCanRunOn.includes(pageId);
 
 	// don't return data if test cannot run on the current front
 	if (!testCanRunOnPage) return undefined;
@@ -257,7 +257,7 @@ export const getEditorialTestData = (
 		return undefined;
 	}
 
-	const variantMeta = activeEditorialTest.variantMeta.find(
+	const variantMeta = activeFrontEditorialTest.variantMeta.find(
 		(variant) => variant.id.toLowerCase() === testBucket,
 	);
 
@@ -266,7 +266,7 @@ export const getEditorialTestData = (
 
 	return {
 		headline: variantMeta.meta.headline,
-		uuid: activeEditorialTest.testUuid,
+		uuid: activeFrontEditorialTest.testUuid,
 	};
 };
 
@@ -280,16 +280,16 @@ export const decideHeadline = (
 	isEditorialABTestingEnabled: boolean,
 	pageId?: string,
 ): string => {
-	const editorialTestData = getEditorialTestData(
+	const frontEditorialTestData = getFrontEditorialTestData(
 		faciaCard,
 		serverSideABTests,
 		isEditorialABTestingEnabled,
 		pageId,
 	);
 
-	if (isUndefined(editorialTestData)) return faciaCard.header.headline;
+	if (isUndefined(frontEditorialTestData)) return faciaCard.header.headline;
 
-	return editorialTestData.headline;
+	return frontEditorialTestData.headline;
 };
 
 /**
@@ -301,16 +301,16 @@ export const findHeadlineTestUuid = (
 	isEditorialABTestingEnabled: boolean,
 	pageId?: string,
 ): string | undefined => {
-	const editorialTestData = getEditorialTestData(
+	const frontEditorialTestData = getFrontEditorialTestData(
 		faciaCard,
 		serverSideABTests,
 		isEditorialABTestingEnabled,
 		pageId,
 	);
 
-	if (isUndefined(editorialTestData)) return undefined;
+	if (isUndefined(frontEditorialTestData)) return undefined;
 
-	return editorialTestData.uuid;
+	return frontEditorialTestData.uuid;
 };
 
 /**