@ministryofjustice/hmpps-probation-integration-e2e-tests 1.149.0 → 1.150.0

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@ministryofjustice/hmpps-probation-integration-e2e-tests",
   "description": "Playwright end to end tests for hmpps-probation-integration-services.",
-  "version": "1.149.0",
+  "version": "1.150.0",
   "license": "MIT",
   "homepage": "https://github.com/ministryofjustice/hmpps-probation-integration-e2e-tests#readme",
   "bugs": {
@@ -41,6 +41,7 @@
     "./steps/api/cvl/cvl-api": "./steps/api/cvl/cvl-api.mjs",
     "./steps/api/dps/prison-api": "./steps/api/dps/prison-api.mjs",
     "./steps/api/epf/epf-api": "./steps/api/epf/epf-api.mjs",
+    "./steps/api/esupervision/esupervision": "./steps/api/esupervision/esupervision.mjs",
     "./steps/api/external-api/external-api": "./steps/api/external-api/external-api.mjs",
     "./steps/api/prison-identifier-and-delius/prison-identifier-and-delius": "./steps/api/prison-identifier-and-delius/prison-identifier-and-delius.mjs",
     "./steps/api/resettlement-passport/resettlement-passport-api": "./steps/api/resettlement-passport/resettlement-passport-api.mjs",
@@ -144,13 +145,14 @@
     "./steps/delius/utils/refresh": "./steps/delius/utils/refresh.mjs",
     "./steps/dps/caseload": "./steps/dps/caseload.mjs",
     "./steps/dps/login": "./steps/dps/login.mjs",
-    "./steps/esupervision/check-in": "./steps/esupervision/check-in.mjs",
     "./steps/hdc-licences/login": "./steps/hdc-licences/login.mjs",
     "./steps/hmpps-auth/login": "./steps/hmpps-auth/login.mjs",
     "./steps/k8s/k8s-utils": "./steps/k8s/k8s-utils.mjs",
     "./steps/make-recall-decisions/flags": "./steps/make-recall-decisions/flags.mjs",
     "./steps/make-recall-decisions/login": "./steps/make-recall-decisions/login.mjs",
     "./steps/make-recall-decisions/start-recommendation": "./steps/make-recall-decisions/start-recommendation.mjs",
+    "./steps/manage-a-supervision/application": "./steps/manage-a-supervision/application.mjs",
+    "./steps/manage-a-supervision/check-in": "./steps/manage-a-supervision/check-in.mjs",
     "./steps/manage-a-supervision/login": "./steps/manage-a-supervision/login.mjs",
     "./steps/manage-pom-cases/caseload": "./steps/manage-pom-cases/caseload.mjs",
     "./steps/manage-pom-cases/login": "./steps/manage-pom-cases/login.mjs",

package/steps/api/esupervision/esupervision.d.mts

@@ -0,0 +1,4 @@
+//#region steps/api/esupervision/esupervision.d.ts
+declare function createOffenderCheckin(crn: string, dueDate: string): Promise<string>;
+//#endregion
+export { createOffenderCheckin };

package/steps/api/esupervision/esupervision.mjs

@@ -0,0 +1,28 @@
+import { getToken } from "../auth/get-token.mjs";
+import { expect, request } from "@playwright/test";
+
+//#region steps/api/esupervision/esupervision.ts
+async function getEsupervisionContext() {
+	const token = await getToken();
+	return request.newContext({
+		baseURL: process.env.ESUPERVISION_API,
+		extraHTTPHeaders: {
+			Accept: "application/json",
+			"Content-Type": "application/json",
+			Authorization: `Bearer ${token}`
+		}
+	});
+}
+async function createOffenderCheckin(crn, dueDate) {
+	const response = await (await getEsupervisionContext()).post("/v2/offender_checkins/crn", { data: {
+		practitioner: "AutomatedTestUser",
+		offender: crn,
+		dueDate
+	} });
+	expect(response.ok(), await response.text()).toBeTruthy();
+	const { uuid } = await response.json();
+	return uuid;
+}
+
+//#endregion
+export { createOffenderCheckin };

package/steps/common/common.d.mts

@@ -3,5 +3,6 @@ import { DateTime } from "luxon";
 //#region steps/common/common.d.ts
 declare const splitDate: (date: DateTime) => string[];
 declare const slow: (minutes?: number) => void;
+declare const qa: (id: string) => string;
 //#endregion
-export { slow, splitDate };
+export { qa, slow, splitDate };

package/steps/common/common.mjs

@@ -14,6 +14,7 @@ const slow = (minutes = 7) => {
 	const duration = Duration.fromObject({ minutes });
 	test.setTimeout(duration.as("milliseconds"));
 };
+const qa = (id) => `[data-qa="${id}"]`;
 
 //#endregion
-export { slow, splitDate };
+export { qa, slow, splitDate };

package/steps/delius/utils/date-time.d.mts

@@ -7,6 +7,12 @@ declare const DeliusDateFormatter: (date: Date) => string;
 declare const OasysDateFormatter: (date: Date) => string;
 declare const DeliusTimeFormatter: (time: Date) => string;
 declare const get12Hour: (date: Date) => number;
+/**
+    Returns a working-day date (Mon–Fri only) in "d/M/yyyy" format.
+    @param offsetWorkingDays Number of working days to move (+1, -1, +10, etc.)
+    @param baseDate Optional base date (defaults to today)
+ */
+declare function getWorkingDayForEsupervision(offsetWorkingDays: number, baseDate?: DateTime): string;
 declare const getTimeOfDay: (date: Date) => "am" | "pm";
 declare const Tomorrow: DateTime<true>;
 declare const NextWeek: DateTime<true>;
@@ -24,5 +30,6 @@ declare const formatDate: (date: Date | DateTime, formatString: string) => strin
 declare const minutesToMilliseconds: (minutes: number) => number;
 declare const secondsToMilliseconds: (seconds: number) => number;
 declare function getCurrentDay(): string;
+declare function uiDateToIso(uiDate: string): string;
 //#endregion
-export { DeliusDateFormatter, DeliusTimeFormatter, HmppsDateFormatter, LastMonth, NextMonth, NextWeek, OasysDateFormatter, Tomorrow, Yesterday, addDays, addMonths, formatDate, get12Hour, getCurrentDay, getDate, getMonth, getTimeOfDay, getYear, minutesToMilliseconds, options, secondsToMilliseconds, subDays, subMonths };
+export { DeliusDateFormatter, DeliusTimeFormatter, HmppsDateFormatter, LastMonth, NextMonth, NextWeek, OasysDateFormatter, Tomorrow, Yesterday, addDays, addMonths, formatDate, get12Hour, getCurrentDay, getDate, getMonth, getTimeOfDay, getWorkingDayForEsupervision, getYear, minutesToMilliseconds, options, secondsToMilliseconds, subDays, subMonths, uiDateToIso };

package/steps/delius/utils/date-time.mjs

@@ -17,6 +17,34 @@ const get12Hour = (date) => {
 	const dt = DateTime.fromJSDate(date);
 	return dt.hour > 12 ? dt.hour - 12 : dt.hour;
 };
+/**
+Returns a working-day date (Mon–Fri only) in "d/M/yyyy" format.
+@param offsetWorkingDays Number of working days to move (+1, -1, +10, etc.)
+@param baseDate Optional base date (defaults to today)
+*/
+function getWorkingDayForEsupervision(offsetWorkingDays, baseDate = DateTime.now().setZone("Europe/London")) {
+	let current = baseDate.startOf("day");
+	if (offsetWorkingDays === 0) {
+		current = moveToWorkingDay(current, 1);
+		return current.toFormat("d/M/yyyy");
+	}
+	const direction = offsetWorkingDays > 0 ? 1 : -1;
+	const steps = Math.abs(offsetWorkingDays);
+	let moved = 0;
+	while (moved < steps) {
+		current = current.plus({ days: direction });
+		if (isWeekday(current)) moved++;
+	}
+	return current.toFormat("d/M/yyyy");
+}
+function isWeekday(date) {
+	return date.weekday >= 1 && date.weekday <= 5;
+}
+function moveToWorkingDay(date, direction) {
+	let d = date;
+	while (!isWeekday(d)) d = d.plus({ days: direction });
+	return d;
+}
 const getTimeOfDay = (date) => DateTime.fromJSDate(date).hour < 12 ? "am" : "pm";
 const Tomorrow = DateTime.now().plus({ days: 1 });
 const NextWeek = DateTime.now().plus({ weeks: 1 });
@@ -60,6 +88,11 @@ const secondsToMilliseconds = (seconds) => {
 function getCurrentDay() {
 	return DateTime.now().weekdayLong;
 }
+function uiDateToIso(uiDate) {
+	const dt = DateTime.fromFormat(uiDate.trim(), "d/M/yyyy", { zone: "Europe/London" });
+	if (!dt.isValid) throw new Error(`Invalid UI date "${uiDate}". Luxon error: ${dt.invalidExplanation ?? dt.invalidReason}`);
+	return dt.toFormat("yyyy-MM-dd");
+}
 
 //#endregion
-export { DeliusDateFormatter, DeliusTimeFormatter, HmppsDateFormatter, LastMonth, NextMonth, NextWeek, OasysDateFormatter, Tomorrow, Yesterday, addDays, addMonths, formatDate, get12Hour, getCurrentDay, getDate, getMonth, getTimeOfDay, getYear, minutesToMilliseconds, options, secondsToMilliseconds, subDays, subMonths };
+export { DeliusDateFormatter, DeliusTimeFormatter, HmppsDateFormatter, LastMonth, NextMonth, NextWeek, OasysDateFormatter, Tomorrow, Yesterday, addDays, addMonths, formatDate, get12Hour, getCurrentDay, getDate, getMonth, getTimeOfDay, getWorkingDayForEsupervision, getYear, minutesToMilliseconds, options, secondsToMilliseconds, subDays, subMonths, uiDateToIso };

package/steps/manage-a-supervision/application.d.mts

@@ -0,0 +1,6 @@
+import { Page } from "@playwright/test";
+
+//#region steps/manage-a-supervision/application.d.ts
+declare function searchPersonInMPoP(page: Page, crn: string, heading?: ReturnType<Page['locator']>): Promise<void>;
+//#endregion
+export { searchPersonInMPoP };

package/steps/manage-a-supervision/application.mjs

@@ -0,0 +1,14 @@
+import { doUntil } from "../delius/utils/refresh.mjs";
+import { expect } from "@playwright/test";
+
+//#region steps/manage-a-supervision/application.ts
+async function searchPersonInMPoP(page, crn, heading) {
+	await page.getByRole("link", { name: "Search" }).click();
+	await page.getByLabel("Find a person on probation").fill(crn);
+	await doUntil(() => page.getByRole("button", { name: "Search" }).click(), () => expect(page.locator("#search-results-container")).toContainText(crn));
+	await page.locator(`[href$="${crn}"]`).first().click();
+	if (heading) await expect(heading).toContainText(/Overview/i);
+}
+
+//#endregion
+export { searchPersonInMPoP };

package/steps/manage-a-supervision/check-in.d.mts

@@ -0,0 +1,9 @@
+import { Person } from "../delius/utils/person.mjs";
+import { Page } from "@playwright/test";
+
+//#region steps/manage-a-supervision/check-in.d.ts
+declare function registerCaseInMPoP(page: Page, person: Person, crn: string): Promise<string>;
+declare function createCheckin(page: Page, uuid: string, person: Person): Promise<void>;
+declare function reviewCheckinInMPoP(page: Page, crn: string): Promise<void>;
+//#endregion
+export { createCheckin, registerCaseInMPoP, reviewCheckinInMPoP };

package/steps/manage-a-supervision/check-in.mjs

@@ -0,0 +1,108 @@
+import { getWorkingDayForEsupervision, options, uiDateToIso } from "../delius/utils/date-time.mjs";
+import { qa } from "../common/common.mjs";
+import { refreshUntil } from "../delius/utils/refresh.mjs";
+import { searchPersonInMPoP } from "./application.mjs";
+import { login } from "./login.mjs";
+import { createOffenderCheckin } from "../api/esupervision/esupervision.mjs";
+import { expect } from "@playwright/test";
+import { DateTime } from "luxon";
+
+//#region steps/manage-a-supervision/check-in.ts
+async function registerCaseInMPoP(page, person, crn) {
+	const uiDueDate = getWorkingDayForEsupervision(1);
+	const apiDueDate = uiDateToIso(uiDueDate);
+	const heading = page.locator(qa("pageHeading"));
+	await login(page);
+	await searchPersonInMPoP(page, crn, heading);
+	await expect(page.locator(qa("crn"))).toContainText(crn);
+	await expect(page.locator(qa("name"))).toContainText(`${person.firstName} ${person.lastName}`);
+	await page.getByRole("link", {
+		name: "Appointments",
+		exact: true
+	}).click();
+	await page.getByRole("link", { name: "Set up online check ins" }).click();
+	await expect(heading).toContainText("How you can use online check ins");
+	await page.getByRole("button", { name: "Continue" }).click();
+	await expect(heading).toContainText(/Set up\s+online check ins/i);
+	await page.locator(".moj-js-datepicker-input").fill(uiDueDate);
+	await page.getByRole("radio", { name: "Every 2 weeks" }).check();
+	await page.getByRole("button", { name: "Continue" }).click();
+	await expect(heading).toContainText(/Contact preferences/i);
+	await page.getByRole("button", { name: /change\s+email\s+address/i }).click();
+	await expect(heading).toContainText(new RegExp(`Edit contact details for ${person.firstName}`, "i"));
+	const email = `${person.lastName}@service.gov.uk`;
+	await page.getByRole("textbox", { name: /Email address/i }).fill(email);
+	await page.getByRole("button", { name: /Save changes/i }).click();
+	await expect(page.locator(".moj-banner__message")).toContainText("Contact details saved");
+	await page.getByRole("radio", { name: "Email" }).check();
+	await page.getByRole("button", { name: "Continue" }).click();
+	await expect(heading).toContainText(new RegExp(`Take a photo of ${person.firstName}`, "i"));
+	await page.getByRole("radio", { name: "Upload a photo" }).check();
+	await page.getByRole("button", { name: "Continue" }).click();
+	await expect(heading).toContainText(new RegExp(`Upload a photo of ${person.firstName}`, "i"));
+	await page.locator("input[type=\"file\"]").setInputFiles("files/mock-person-photo.png");
+	await page.getByRole("button", { name: "Continue" }).click();
+	await expect(heading).toContainText("Does this photo meet the rules?");
+	await page.getByRole("link", { name: /Yes,\s*continue/i }).click();
+	await expect(heading).toContainText(/Check your answers before adding/i);
+	await page.getByRole("button", { name: "Confirm" }).click();
+	await expect(page.locator(".govuk-panel--confirmation")).toContainText("Online check ins added");
+	return await createOffenderCheckin(crn, apiDueDate);
+}
+async function createCheckin(page, uuid, person) {
+	await page.goto(`${process.env.PROBATION_CHECK_IN_URL}/${uuid}`);
+	await page.getByRole("button", { name: "Start now" }).click();
+	await enterPersonalDetails(page, person);
+	await page.getByRole("button", { name: "Continue" }).click();
+	await page.getByRole("radio", { name: "Very well" }).check();
+	await page.getByRole("button", { name: "Continue" }).click();
+	await page.getByRole("checkbox", { name: "No, I do not need help" }).check();
+	await page.getByRole("button", { name: "Continue" }).click();
+	await page.getByRole("radio", { name: "No" }).check();
+	await page.getByRole("button", { name: "Continue" }).click();
+	await page.getByRole("button", { name: "Continue" }).click();
+	await page.getByRole("button", { name: "Start recording" }).click();
+	await page.getByRole("button", { name: /Submit video anyway/ }).click();
+	await page.getByRole("checkbox", { name: /I confirm/ }).check();
+	await page.getByRole("button", { name: "Complete check in" }).click();
+	await expect(page.locator("h1")).toContainText("Check in completed");
+}
+async function enterPersonalDetails(page, person) {
+	await page.getByRole("textbox", { name: "First name" }).fill(person.firstName);
+	await page.getByRole("textbox", { name: "Last name" }).fill(person.lastName);
+	const dob = DateTime.fromJSDate(person.dob);
+	await page.getByRole("textbox", { name: "Day" }).fill(dob.day.toString());
+	await page.getByRole("textbox", { name: "Month" }).fill(dob.month.toString());
+	await page.getByRole("textbox", { name: "Year" }).fill(dob.year.toString());
+}
+async function reviewCheckinInMPoP(page, crn) {
+	const heading = page.locator(qa("pageHeading"));
+	await page.goto(process.env.MANAGE_PEOPLE_ON_PROBATION_URL);
+	await searchPersonInMPoP(page, crn, heading);
+	await page.getByRole("link", {
+		name: "Contacts",
+		exact: true
+	}).click();
+	await expect(heading).toContainText("Contacts");
+	await refreshUntil(page, async () => {
+		await expect(page.getByRole("link", { name: "Online probation check in" })).toBeVisible();
+	}, options);
+	await page.getByRole("link", {
+		name: "Online probation check in",
+		exact: true
+	}).click();
+	await expect(heading).toContainText("Online check in submitted");
+	await page.getByRole("radio", { name: "Yes" }).check();
+	await page.getByRole("button", { name: "Confirm and review responses" }).click();
+	await expect(heading).toContainText("Online check in submitted");
+	await page.getByRole("button", { name: "Confirm review" }).click();
+	await expect(page.locator(qa("descriptionValue"))).toContainText("Online check in completed");
+	const checkinCard = page.locator("section.app-summary-card", { has: page.getByRole("link", { name: /online probation check in/i }) });
+	await refreshUntil(page, async () => {
+		await expect(checkinCard).toBeVisible();
+		await expect(checkinCard).toContainText(/Checkin status:\s*Reviewed/i);
+	}, options);
+}
+
+//#endregion
+export { createCheckin, registerCaseInMPoP, reviewCheckinInMPoP };

package/steps/esupervision/check-in.d.mts

@@ -1,9 +0,0 @@
-import { Person } from "../delius/utils/person.mjs";
-import { Page } from "@playwright/test";
-
-//#region steps/esupervision/check-in.d.ts
-declare function registerCase(page: Page, person: Person, crn: string): Promise<string>;
-declare function createCheckin(page: Page, uuid: string, person: Person): Promise<void>;
-declare function reviewCheckin(page: Page, person: Person): Promise<void>;
-//#endregion
-export { createCheckin, registerCase, reviewCheckin };

package/steps/esupervision/check-in.mjs

@@ -1,70 +0,0 @@
-import { DeliusDateFormatter } from "../delius/utils/date-time.mjs";
-import { login } from "../hmpps-auth/login.mjs";
-import { expect } from "@playwright/test";
-import { DateTime } from "luxon";
-
-//#region steps/esupervision/check-in.ts
-async function registerCase(page, person, crn) {
-	await login(page);
-	await page.goto(process.env.ESUPERVISION_URL);
-	await page.getByRole("button", { name: "Add person" }).click();
-	await enterPersonalDetails(page, person);
-	await page.getByRole("textbox", { name: /CRN/ }).fill(crn);
-	await page.getByRole("button", { name: "Continue" }).click();
-	await page.getByRole("link", { name: "Upload photo instead" }).click();
-	await page.locator("#photoUpload-input").setInputFiles("files/mock-person-photo.png");
-	await page.getByRole("button", { name: "Upload photo" }).click();
-	await page.getByRole("link", { name: "Yes, continue" }).click();
-	await page.getByRole("radio", { name: "Email" }).check();
-	await page.getByRole("button", { name: "Continue" }).click();
-	await page.locator("#email").fill(`simulate-delivered+${person.firstName}${person.lastName}@notifications.service.gov.uk`);
-	await page.getByRole("button", { name: "Continue" }).click();
-	await page.locator("#startDate").fill(DeliusDateFormatter(/* @__PURE__ */ new Date()));
-	await page.getByRole("radio", { name: "Every 8 weeks" }).check();
-	await page.getByRole("button", { name: "Continue" }).click();
-	await page.getByRole("button", { name: "Confirm and add person" }).click();
-	await page.getByRole("link", { name: "Awaiting check in" }).click();
-	const cell = page.getByRole("cell", {
-		name: person.firstName + " " + person.lastName,
-		exact: true
-	});
-	return await page.getByRole("row").filter({ has: cell }).getAttribute("data-checkin-uuid");
-}
-async function createCheckin(page, uuid, person) {
-	await page.goto(`${process.env.ESUPERVISION_URL}/submission/${uuid}`);
-	await page.getByRole("button", { name: "Start now" }).click();
-	await enterPersonalDetails(page, person);
-	await page.getByRole("button", { name: "Continue" }).click();
-	await page.getByRole("radio", { name: "Very well" }).check();
-	await page.getByRole("button", { name: "Continue" }).click();
-	await page.getByRole("checkbox", { name: "No, I do not need help" }).check();
-	await page.getByRole("button", { name: "Continue" }).click();
-	await page.getByRole("radio", { name: "No" }).check();
-	await page.getByRole("button", { name: "Continue" }).click();
-	await page.getByRole("button", { name: "Continue" }).click();
-	await page.getByRole("button", { name: "Start recording" }).click();
-	await page.getByRole("button", { name: /Submit video anyway/ }).click();
-	await page.getByRole("checkbox", { name: /I confirm/ }).check();
-	await page.getByRole("button", { name: "Complete check in" }).click();
-	await expect(page.locator("h1")).toContainText("Check in completed");
-}
-async function enterPersonalDetails(page, person) {
-	await page.getByRole("textbox", { name: "First name" }).fill(person.firstName);
-	await page.getByRole("textbox", { name: "Last name" }).fill(person.lastName);
-	const dob = DateTime.fromJSDate(person.dob);
-	await page.getByRole("textbox", { name: "Day" }).fill(dob.day.toString());
-	await page.getByRole("textbox", { name: "Month" }).fill(dob.month.toString());
-	await page.getByRole("textbox", { name: "Year" }).fill(dob.year.toString());
-}
-async function reviewCheckin(page, person) {
-	await page.goto(process.env.ESUPERVISION_URL);
-	await page.getByRole("row").filter({ has: page.getByRole("cell", {
-		name: person.firstName + " " + person.lastName,
-		exact: true
-	}) }).getByRole("link", { name: /Review/ }).click();
-	await page.getByRole("radio", { name: "Yes" }).check();
-	await page.getByRole("button", { name: "Mark as reviewed" }).click();
-}
-
-//#endregion
-export { createCheckin, registerCase, reviewCheckin };