AUT-2578: Convert send notification service to use common headers

govuk-one-login · May 21, 2024 · 28aef8f · 28aef8f
1 parent be7affb
commit 28aef8f
Show file tree

Hide file tree

Showing 12 changed files with 45 additions and 16 deletions.
diff --git a/src/components/account-creation/resend-mfa-code/resend-mfa-code-controller.ts b/src/components/account-creation/resend-mfa-code/resend-mfa-code-controller.ts
@@ -83,6 +83,7 @@ export const resendMfaCodePost = (
       req.ip,
       persistentSessionId,
       xss(req.cookies.lng as string),
+      req,
       journeyType,
       phoneNumber
     );

diff --git a/src/components/account-creation/resend-mfa-code/tests/resend-mfa-code-controller.test.ts b/src/components/account-creation/resend-mfa-code/tests/resend-mfa-code-controller.test.ts
@@ -81,6 +81,7 @@ describe("resend mfa controller", () => {
         "127.0.0.1",
         "123123-djjad",
         "",
+        req,
         "ACCOUNT_RECOVERY"
       );
     });
@@ -110,6 +111,7 @@ describe("resend mfa controller", () => {
         "127.0.0.1",
         "123123-djjad",
         "",
+        req,
         "REGISTRATION"
       );
     });

diff --git a/src/components/account-not-found/account-not-found-controller.ts b/src/components/account-not-found/account-not-found-controller.ts
@@ -48,6 +48,7 @@ export function accountNotFoundPost(
       req.ip,
       persistentSessionId,
       xss(req.cookies.lng as string),
+      req,
       JOURNEY_TYPE.REGISTRATION
     );
 

diff --git a/src/components/account-recovery/check-your-email-security-codes/send-email-otp-middleware.ts b/src/components/account-recovery/check-your-email-security-codes/send-email-otp-middleware.ts
@@ -31,6 +31,7 @@ export function sendEmailOtp(
       req.ip,
       persistentSessionId,
       xss(req.cookies.lng as string),
+      req,
       JOURNEY_TYPE.ACCOUNT_RECOVERY
     );
 

diff --git a/src/components/check-your-phone/check-your-phone-controller.ts b/src/components/check-your-phone/check-your-phone-controller.ts
@@ -113,6 +113,7 @@ export const checkYourPhonePost = (
       req.ip,
       res.locals.persistentSessionId,
       xss(req.cookies.lng as string),
+      req,
       journeyType
     );
 

diff --git a/src/components/common/send-notification/send-notification-service.ts b/src/components/common/send-notification/send-notification-service.ts
@@ -2,11 +2,12 @@ import { ApiResponseResult, DefaultApiResponse } from "../../../types";
 import { API_ENDPOINTS, HTTP_STATUS_CODES } from "../../../app.constants";
 import {
   createApiResponse,
-  getRequestConfig,
+  getInternalRequestConfigWithSecurityHeaders,
   http,
   Http,
 } from "../../../utils/http";
 import { SendNotificationServiceInterface } from "./types";
+import { Request } from "express";
 
 export function sendNotificationService(
   axios: Http = http
@@ -19,6 +20,7 @@ export function sendNotificationService(
     sourceIp: string,
     persistentSessionId: string,
     userLanguage: string,
+    req: Request,
     journeyType?: string,
     phoneNumber?: string,
     requestNewCode?: boolean
@@ -43,17 +45,21 @@ export function sendNotificationService(
     const response = await axios.client.post<DefaultApiResponse>(
       API_ENDPOINTS.SEND_NOTIFICATION,
       payload,
-      getRequestConfig({
-        sessionId: sessionId,
-        clientSessionId: clientSessionId,
-        sourceIp: sourceIp,
-        persistentSessionId: persistentSessionId,
-        validationStatuses: [
-          HTTP_STATUS_CODES.NO_CONTENT,
-          HTTP_STATUS_CODES.BAD_REQUEST,
-        ],
-        userLanguage: userLanguage,
-      })
+      getInternalRequestConfigWithSecurityHeaders(
+        {
+          sessionId: sessionId,
+          clientSessionId: clientSessionId,
+          sourceIp: sourceIp,
+          persistentSessionId: persistentSessionId,
+          validationStatuses: [
+            HTTP_STATUS_CODES.NO_CONTENT,
+            HTTP_STATUS_CODES.BAD_REQUEST,
+          ],
+          userLanguage: userLanguage,
+        },
+        req,
+        API_ENDPOINTS.SEND_NOTIFICATION
+      )
     );
 
     return createApiResponse<DefaultApiResponse>(response, [

diff --git a/src/components/common/send-notification/tests/send-notification-service.test.ts b/src/components/common/send-notification/tests/send-notification-service.test.ts
@@ -4,14 +4,20 @@ import { Http } from "../../../../utils/http";
 import {
   checkApiCallMadeWithExpectedBodyAndHeaders,
   commonVariables,
-  expectedHeadersFromCommonVarsWithoutSecurityHeaders,
+  expectedHeadersFromCommonVarsWithSecurityHeaders,
+  requestHeadersWithIpAndAuditEncoded,
   resetApiKeyAndBaseUrlEnvVars,
   setupApiKeyAndBaseUrlEnvVars,
 } from "../../../../../test/helpers/service-test-helper";
-import { API_ENDPOINTS, NOTIFICATION_TYPE } from "../../../../app.constants";
+import {
+  API_ENDPOINTS,
+  NOTIFICATION_TYPE,
+  PATH_NAMES,
+} from "../../../../app.constants";
 import { SendNotificationServiceInterface } from "../types";
 import { sendNotificationService } from "../send-notification-service";
 import { JOURNEY_TYPE } from "../../constants";
+import { createMockRequest } from "../../../../../test/helpers/mock-request-helper";
 
 describe("send notification service", () => {
   let postStub: SinonStub;
@@ -23,10 +29,13 @@ describe("send notification service", () => {
   });
   const { sessionId, clientSessionId, email, ip, diPersistentSessionId } =
     commonVariables;
+  const req = createMockRequest(PATH_NAMES.RESEND_MFA_CODE, {
+    headers: requestHeadersWithIpAndAuditEncoded,
+  });
   const notificationType = NOTIFICATION_TYPE.VERIFY_EMAIL;
   const userLanguage = "cy";
   const expectedHeaders = {
-    ...expectedHeadersFromCommonVarsWithoutSecurityHeaders,
+    ...expectedHeadersFromCommonVarsWithSecurityHeaders,
     "User-Language": userLanguage,
   };
 
@@ -51,7 +60,8 @@ describe("send notification service", () => {
       notificationType,
       ip,
       diPersistentSessionId,
-      userLanguage
+      userLanguage,
+      req
     );
 
     const expectedApiCallDetails = {
@@ -81,6 +91,7 @@ describe("send notification service", () => {
       ip,
       diPersistentSessionId,
       userLanguage,
+      req,
       journeyType,
       phoneNumber,
       requestNewCode

diff --git a/src/components/common/send-notification/types.ts b/src/components/common/send-notification/types.ts
@@ -1,4 +1,5 @@
 import { ApiResponseResult, DefaultApiResponse } from "../../../types";
+import { Request } from "express";
 
 export interface SendNotificationServiceInterface {
   sendNotification: (
@@ -9,6 +10,7 @@ export interface SendNotificationServiceInterface {
     sourceIp: string,
     persistentSessionId: string,
     userLanguage: string,
+    req: Request,
     journeyType?: string,
     phoneNumber?: string,
     requestNewCode?: boolean

diff --git a/src/components/enter-email/enter-email-controller.ts b/src/components/enter-email/enter-email-controller.ts
@@ -192,6 +192,7 @@ export function enterEmailCreatePost(
       req.ip,
       persistentSessionId,
       xss(req.cookies.lng as string),
+      req,
       JOURNEY_TYPE.REGISTRATION
     );
 

diff --git a/src/components/enter-phone-number/enter-phone-number-controller.ts b/src/components/enter-phone-number/enter-phone-number-controller.ts
@@ -88,6 +88,7 @@ export function enterPhoneNumberPost(
       req.ip,
       persistentSessionId,
       xss(req.cookies.lng as string),
+      req,
       journeyType,
       phoneNumber
     );

diff --git a/src/components/resend-email-code/resend-email-code-controller.ts b/src/components/resend-email-code/resend-email-code-controller.ts
@@ -68,6 +68,7 @@ export function resendEmailCodePost(
       req.ip,
       persistentSessionId,
       xss(req.cookies.lng as string),
+      req,
       journeyType,
       undefined,
       xss(req.body.requestNewCode as string) === "true"

diff --git a/src/components/setup-authenticator-app/setup-authenticator-app-controller.ts b/src/components/setup-authenticator-app/setup-authenticator-app-controller.ts
@@ -137,6 +137,7 @@ export function setupAuthenticatorAppPost(
       req.ip,
       res.locals.persistentSessionId,
       xss(req.cookies.lng as string),
+      req,
       journeyType
     );
-Original file line number
+Diff line change
@@ Expand Up / @@ -48,6 +48,7 @@ export function accountNotFoundPost( @@
           req.ip,
           persistentSessionId,
           xss(req.cookies.lng as string),
+          req,
           JOURNEY_TYPE.REGISTRATION
         );
@@ Expand Down @@