SPIKE SB Use yarl-like Url class.

Author: acerathereinspirative-nhs-nvir

contract/fetch-eligibility-content.contract.ts

@@ -1,6 +1,7 @@
 import { NhsNumber } from "@src/models/vaccine";
 import { EligibilityApiResponse } from "@src/services/eligibility-api/api-types";
 import { fetchEligibilityContent } from "@src/services/eligibility-api/gateway/fetch-eligibility-content";
+import { Url } from "@src/utils/Url";
 import config from "@src/utils/config";
 import { asyncLocalStorage } from "@src/utils/requestContext";
 import { ConfigMock, configBuilder } from "@test-data/config/builders";
@@ -44,7 +45,7 @@ pactWith({ consumer: "VitA", provider: "EliD", port: 1234, logLevel: "warn" }, (
 
   beforeEach(() => {
     const defaultConfig = configBuilder()
-      .withEligibilityApiEndpoint(new URL("http://localhost:1234/"))
+      .withEligibilityApiEndpoint(new Url("http://localhost:1234/"))
       .andEligibilityApiKey("test-api-key")
       .andIsApimAuthEnabled(false)
       .build();

e2e/auth.ts

@@ -1,5 +1,6 @@
 import { Browser, Page } from "@playwright/test";
 import { getEnv } from "@project/e2e/helpers";
+import { Url } from "@src/utils/Url";
 
 interface User {
   nhsAppLoginUrl: string;
@@ -61,7 +62,7 @@ export const login = async (browser: Browser, nhsLoginUsername: string): Promise
   await page.getByRole("button", { name: "Continue" }).click();
 
   await page.waitForURL(/\/(enter-mobile-code|choose-authentication-method)$/, { timeout: 30000 });
-  if (new URL(page.url()).pathname === "/choose-authentication-method") {
+  if (new Url(page.url()).path === "/choose-authentication-method") {
     await page.getByLabel("Use my mobile phone to recieve a security code by text message").click();
     await page.getByRole("button", { name: "Continue" }).click();
   }
@@ -78,7 +79,7 @@ export const login = async (browser: Browser, nhsLoginUsername: string): Promise
     return page;
   } else {
     await page.waitForURL(/\/(terms-and-conditions\?redirect_to=index|patient\/)$/, { timeout: 30000 });
-    if (new URL(page.url()).pathname === "/terms-and-conditions") {
+    if (new Url(page.url()).path === "/terms-and-conditions") {
       await page.locator("#termsAndConditions-agree_checkbox").setChecked(true);
       await page.getByRole("button", { name: "Continue" }).click();
     }

src/_lambda/content-cache-hydrator/content-change-detector.test.ts

@@ -1,5 +1,6 @@
 import { vitaContentChangedSinceLastApproved } from "@src/_lambda/content-cache-hydrator/content-change-detector";
 import { VaccinePageContent } from "@src/services/content-api/types";
+import { Url } from "@src/utils/Url";
 
 const mockPreviousApprovedVaccineContent: VaccinePageContent = {
   overview: { content: "This is an overview", containsHtml: false },
@@ -47,7 +48,7 @@ const mockPreviousApprovedVaccineContent: VaccinePageContent = {
       },
     ],
   },
-  webpageLink: new URL("https://test.example.com/"),
+  webpageLink: new Url("https://test.example.com/"),
 };
 
 describe("vitaContentChangedSinceLastApproved", () => {

src/_lambda/content-cache-hydrator/content-fetcher.test.ts

@@ -1,5 +1,6 @@
 import { CONTENT_API_PATH_PREFIX, fetchContentForVaccine } from "@src/_lambda/content-cache-hydrator/content-fetcher";
 import { VaccineInfo, VaccineType } from "@src/models/vaccine";
+import { Url } from "@src/utils/Url";
 import config from "@src/utils/config";
 import { ConfigMock, configBuilder } from "@test-data/config/builders";
 import axios from "axios";
@@ -9,7 +10,7 @@ jest.mock("sanitize-data", () => ({ sanitize: jest.fn() }));
 
 describe("fetchContentForVaccine", () => {
   const testApiKey: string = "test-key";
-  const testApiEndpoint: URL = new URL("https://test-endpoint/");
+  const testApiEndpoint: Url = new Url("https://test-endpoint/");
   const testApiContent = { test: "content" };
   const mockedConfig = config as ConfigMock;
 

src/_lambda/content-cache-hydrator/content-fetcher.ts

@@ -1,4 +1,5 @@
 import { VaccineInfo, VaccineType } from "@src/models/vaccine";
+import { Url } from "@src/utils/Url";
 import config from "@src/utils/config";
 import { logger } from "@src/utils/logger";
 import axios, { AxiosError, AxiosResponse } from "axios";
@@ -7,7 +8,7 @@ const log = logger.child({ module: "content-fetcher" });
 const CONTENT_API_PATH_PREFIX = "nhs-website-content/";
 
 const fetchContentForVaccine = async (vaccineType: VaccineType): Promise<string> => {
-  const apiEndpoint: URL = await config.CONTENT_API_ENDPOINT;
+  const apiEndpoint: Url = await config.CONTENT_API_ENDPOINT;
   const vaccinePath = VaccineInfo[vaccineType].contentPath;
   const apiKey: string = await config.CONTENT_API_KEY;
 

src/app/_components/content/FindOutMore.tsx

@@ -1,7 +1,8 @@
 import { VaccineInfo, VaccineType } from "@src/models/vaccine";
+import { Url } from "@src/utils/Url";
 import React, { JSX } from "react";
 
-const FindOutMoreLink = (props: { findOutMoreUrl: URL; vaccineType: VaccineType }): JSX.Element => {
+const FindOutMoreLink = (props: { findOutMoreUrl: Url; vaccineType: VaccineType }): JSX.Element => {
   const vaccineInfo = VaccineInfo[props.vaccineType];
 
   return (

src/app/_components/eligibility/EligibilityActions.test.tsx

@@ -1,4 +1,5 @@
 import { ActionDisplayType, ButtonUrl, Label } from "@src/services/eligibility-api/types";
+import { Url } from "@src/utils/Url";
 import { actionBuilder, buttonBuilder } from "@test-data/eligibility-api/builders";
 import { render, screen, within } from "@testing-library/react";
 import React from "react";
@@ -288,7 +289,7 @@ describe("EligibilityActions", () => {
                 .andButton(
                   buttonBuilder()
                     .withLabel("Action Link Test" as Label)
-                    .andUrl(new URL("https://example.com/bacon/") as ButtonUrl)
+                    .andUrl(new Url("https://example.com/bacon/") as ButtonUrl)
                     .build(),
                 )
                 .build(),

src/app/_components/feedback/FeedbackBanner.test.tsx

@@ -1,4 +1,5 @@
 import { FeedbackBanner } from "@src/app/_components/feedback/FeedbackBanner";
+import { Url } from "@src/utils/Url";
 import { render, screen } from "@testing-library/react";
 
 describe("FeedbackBanner", () => {
@@ -9,7 +10,7 @@ describe("FeedbackBanner", () => {
 
     const feedbackText: HTMLElement = screen.getByText(/This is a new NHS App service\. Help us improve it and/i);
     const feedbackLink: HTMLAnchorElement = screen.getByRole("link", { name: "give your feedback" });
-    const feedbackUrl: URL = new URL(feedbackLink.href);
+    const feedbackUrl: Url = new Url(feedbackLink.href);
 
     expect(feedbackText).toBeVisible();
     expect(feedbackLink).toBeVisible();

src/app/_components/interceptor/LinksInterceptor.tsx

@@ -14,8 +14,7 @@ const LinksInterceptor = (): null => {
       const anchor: HTMLAnchorElement | null = target.closest("a");
       if (!anchor) return;
 
-      const url = new URL(anchor.href);
-      const isExternal = url.origin !== window.location.origin;
+      const isExternal = anchor.origin !== window.location.origin;
 
       if (isExternal && hasContextLoaded && isOpenInMobileApp) {
         event.preventDefault(); // Stop default navigation

src/app/api/sso-to-nbs/route.ts

@@ -1,6 +1,7 @@
 import { SSO_FAILURE_ROUTE } from "@src/app/sso-failure/constants";
 import { VaccineType } from "@src/models/vaccine";
 import { getNbsQueryParams, getSSOUrlToNBSForVaccine } from "@src/services/nbs/nbs-service";
+import { Url } from "@src/utils/Url";
 import { logger } from "@src/utils/logger";
 import { getVaccineTypeFromLowercaseString } from "@src/utils/path";
 import { profilePerformanceEnd, profilePerformanceStart } from "@src/utils/performance";
@@ -44,7 +45,7 @@ async function getGivenRedirectTarget(rawRedirectTarget: string | null) {
 
   if (rawRedirectTarget) {
     try {
-      const nbsURl = new URL(decodeURI(rawRedirectTarget ?? ""));
+      const nbsURl = new Url(decodeURI(rawRedirectTarget ?? ""));
       try {
         const nbsQueryParams = await getNbsQueryParams();
         nbsQueryParams.forEach((param) => {