Football Data Pages: Add mappings for live match status (#13604)

* add mappings for live match status

* refactor tests to not export parsing internals

Author: andrewHEguardian

dotcom-rendering/fixtures/manual/footballMatches.ts

@@ -70,6 +70,11 @@ export const matchDayLive: FEMatchDay = {
 	},
 };
 
+export const matchDayLiveSecondHalf: FEMatchDay = {
+	...matchDayLive,
+	matchStatus: 'SHS',
+};
+
 export const liveMatch: FELive = {
 	...matchData,
 	type: 'LiveMatch',

dotcom-rendering/src/footballMatches.test.ts

@@ -3,6 +3,7 @@ import {
 	emptyMatches,
 	liveMatch,
 	matchDayLive,
+	matchDayLiveSecondHalf,
 	matchFixture,
 	matchResult,
 } from '../fixtures/manual/footballMatches';
@@ -12,7 +13,7 @@ import type {
 	FEMatchDay,
 	FEResult,
 } from './feFootballDataPage';
-import { parse, parseMatchResult } from './footballMatches';
+import { parse } from './footballMatches';
 import { errorOrThrow, okOrThrow } from './lib/result';
 
 const withMatches = (
@@ -190,11 +191,48 @@ describe('footballMatches', () => {
 		for (const [uncleanName, cleanName] of Object.entries(
 			uncleanToCleanNames,
 		)) {
-			const match = okOrThrow(
-				parseMatchResult(matchesListWithTeamName(uncleanName)),
+			const matchDay = okOrThrow(
+				parse(withMatches([matchesListWithTeamName(uncleanName)])),
 				'Expected football match parsing to succeed',
 			);
+
+			const match = matchDay[0]!.competitions[0]!.matches[0];
+			if (match?.kind !== 'Result') {
+				throw new Error('Expected Result');
+			}
+
 			expect(match.homeTeam.name).toBe(cleanName);
 		}
 	});
+	it('should replace known live match status with our status', () => {
+		const matchDay = okOrThrow(
+			parse(withMatches([matchDayLiveSecondHalf])),
+			'Expected football live match parsing to succeed',
+		);
+
+		const match = matchDay[0]!.competitions[0]!.matches[0];
+		if (match?.kind !== 'Live') {
+			throw new Error('Expected live match');
+		}
+
+		expect(match.status).toBe('2nd');
+	});
+	it('should replace unknown live match status with first two characters', () => {
+		const matchDayLiveUnknownStatus = {
+			...matchDayLiveSecondHalf,
+			matchStatus: 'Something odd',
+		};
+
+		const matchDay = okOrThrow(
+			parse(withMatches([matchDayLiveUnknownStatus])),
+			'Expected football live match parsing to succeed',
+		);
+
+		const match = matchDay[0]!.competitions[0]!.matches[0];
+		if (match?.kind !== 'Live') {
+			throw new Error('Expected live match');
+		}
+
+		expect(match.status).toBe('So');
+	});
 });

dotcom-rendering/src/footballMatches.ts

@@ -229,7 +229,7 @@ const parseFixture = (
 	});
 };
 
-export const parseMatchResult = (
+const parseMatchResult = (
 	feResult: FEResult | FEMatchDay,
 ): Result<ParserError, MatchResult> => {
 	if (feResult.type === 'MatchDay' && !feResult.result) {
@@ -314,7 +314,7 @@ const parseLiveMatch = (
 		dateTimeISOString: date.value,
 		paId: feMatchDay.id,
 		comment: feMatchDay.comments,
-		status: feMatchDay.matchStatus,
+		status: replaceLiveMatchStatus(feMatchDay.matchStatus),
 	});
 };
 
@@ -441,3 +441,35 @@ const cleanTeamName = (teamName: string): string => {
 		.replace('Bialystock', 'Białystok')
 		.replace('Union Saint Gilloise', 'Union Saint-Gilloise');
 };
+
+// This comes from Frontend
+const paStatusToMatchStatus: Record<string, string> = {
+	KO: '1st', // The Match has started Kicked Off.
+	HT: 'HT', // The Referee has blown the whistle for Half Time.
+	SHS: '2nd', // The Second Half of the Match has Started.
+	FT: 'FT', // The Referee has blown the whistle for Full Time.
+	PTFT: 'FT', // Penalty Shootout Full Time.
+	Result: 'FT', // The Result is official.
+	ETFT: 'FT', // Extra Time, Full Time has been blown.
+	MC: 'FT', // Match has been Completed.
+	FTET: 'ET', // Full Time, Extra Time it to be played.
+	ETS: 'ET', // Extra Time has Started.
+	ETHT: 'ET', // Extra Time Half Time has been called.
+	ETSHS: 'ET', // Extra Time, Second Half has Started.
+	FTPT: 'PT', // Full Time, Penalties are To be played.
+	PT: 'PT', // Penalty Shootout has started.
+	ETFTPT: 'PT', // Extra Time, Full Time, Penalties are To be played.
+	Suspended: 'S', // Match has been Suspended.
+
+	// We don't really expect to see these the way we handle data in frontend
+	Resumed: 'R', // Match has been Resumed.
+	Abandoned: 'A', // Match has been Abandoned.
+	Fixture: 'F', // Created Fixture is available and had been Created by us.
+	'-': 'F', // this sneaky one is not in the docs
+	New: 'N', // Match A New Match has been added to our data.
+	Cancelled: 'C', // A Match has been Cancelled.
+};
+
+const replaceLiveMatchStatus = (status: string): string => {
+	return paStatusToMatchStatus[status] ?? status.slice(0, 2);
+};