chore: migrated nhsNotifyLambda tests passing

tstephen-nhs · tstephen-nhs · commit 60e360677e6c · 2026-03-31T16:32:31.000Z
diff --git a/packages/nhsNotifyLambda/.vscode/launch.json b/packages/nhsNotifyLambda/.vscode/launch.json
@@ -1,35 +1,40 @@
 {
-  // Use IntelliSense to learn about possible attributes.
-  // Hover to view descriptions of existing attributes.
-  // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
   "version": "0.2.0",
   "configurations": [
-      {
-          "type": "node",
-          "name": "vscode-jest-tests.v2",
-          "request": "launch",
-          "args": [
-              "--runInBand",
-              "--watchAll=false",
-              "--testNamePattern",
-              "${jest.testNamePattern}",
-              "--runTestsByPath",
-              "${jest.testFile}",
-              "--config",
-              "${workspaceFolder}/jest.debug.config.ts"
-          ],
-          "cwd": "${workspaceFolder}",
-          "console": "integratedTerminal",
-          "internalConsoleOptions": "neverOpen",
-          "disableOptimisticBPs": true,
-          "program": "${workspaceFolder}/../../node_modules/.bin/jest",
-          "windows": {
-              "program": "${workspaceFolder}/node_modules/jest/bin/jest"
-          },
-          "env": {
-              "POWERTOOLS_DEV": true,
-              "NODE_OPTIONS": "--experimental-vm-modules"
-          }
-      }
+        {
+            "name": "vitest: all tests",
+            "type": "node",
+            "request": "launch",
+            "cwd": "${workspaceFolder}",
+            "runtimeExecutable": "${workspaceFolder}/../../node_modules/vitest/vitest.mjs",
+            "args": [
+                "run",
+                "--config",
+                "vitest.config.ts"
+            ],
+            "env": {
+                "POWERTOOLS_DEV": "true"
+            },
+            "console": "integratedTerminal",
+            "internalConsoleOptions": "neverOpen"
+        },
+        {
+            "name": "vitest: current file",
+            "type": "node",
+            "request": "launch",
+            "cwd": "${workspaceFolder}",
+            "runtimeExecutable": "${workspaceFolder}/../../node_modules/vitest/vitest.mjs",
+            "args": [
+                "run",
+                "${relativeFile}",
+                "--config",
+                "vitest.config.ts"
+            ],
+            "env": {
+                "POWERTOOLS_DEV": "true"
+            },
+            "console": "integratedTerminal",
+            "internalConsoleOptions": "neverOpen"
+        }
   ]
 }
diff --git a/packages/nhsNotifyLambda/.vscode/settings.json b/packages/nhsNotifyLambda/.vscode/settings.json
@@ -1,7 +1,3 @@
 {
-  "jest.jestCommandLine": "/workspaces/eps-prescription-status-update-api/node_modules/.bin/jest --no-cache",
-  "jest.nodeEnv": {
-    "POWERTOOLS_DEV": true,
-    "NODE_OPTIONS": "--experimental-vm-modules"
-  }
+  "testing.automaticallyOpenPeekView": "never"
 }
diff --git a/packages/nhsNotifyLambda/package.json b/packages/nhsNotifyLambda/package.json
@@ -7,7 +7,7 @@
   "license": "MIT",
   "type": "module",
   "scripts": {
-    "unit": "POWERTOOLS_DEV=true NODE_OPTIONS=--experimental-vm-modules jest --no-cache --coverage",
+    "unit": "POWERTOOLS_DEV=true vitest run --config vitest.config.ts --coverage",
     "lint": "eslint  --max-warnings 0 --fix --config ../../eslint.config.mjs .",
     "compile": "tsc",
     "test": "npm run compile && npm run unit",
diff --git a/packages/nhsNotifyLambda/tests/notify.test.ts b/packages/nhsNotifyLambda/tests/notify.test.ts
@@ -1,4 +1,4 @@
-import {jest, describe, it} from "@jest/globals"
+import {vi, describe, it} from "vitest"
 
 import {Logger} from "@aws-lambda-powertools/logger"
 import {logNotificationRequest} from "../src/utils/notify"
@@ -7,13 +7,11 @@ import {LOG_MESSAGES} from "@psu-common/utilities"
 
 // Mock crypto.randomUUID
 const mockUUID = "550e8400-e29b-41d4-a716-446655440000"
-globalThis.crypto = {
-  randomUUID: () => mockUUID
-} as unknown as Crypto
+vi.spyOn(globalThis.crypto, "randomUUID").mockReturnValue(mockUUID)
 
-const mockInfo = jest.fn()
-const mockError = jest.fn()
-const mockWarn = jest.fn()
+const mockInfo = vi.fn()
+const mockError = vi.fn()
+const mockWarn = vi.fn()
 
 describe("logNotificationRequest", () => {
   let mockLogger: Logger
@@ -70,7 +68,7 @@ describe("logNotificationRequest", () => {
 
     data = [dataItem1, dataItem2]
 
-    jest.clearAllMocks()
+    vi.clearAllMocks()
   })
 
   it("should log legacy notification request summary", () => {
diff --git a/packages/nhsNotifyLambda/tests/testAuth.test.ts b/packages/nhsNotifyLambda/tests/testAuth.test.ts
@@ -1,12 +1,15 @@
-import {jest} from "@jest/globals"
+import {vi} from "vitest"
 import nock from "nock"
 
 import {Logger} from "@aws-lambda-powertools/logger"
 import axios, {AxiosInstance} from "axios"
 
-const mockImportPKCS8 = jest.fn()
-const mockSignJWTConstructor = jest.fn()
-jest.unstable_mockModule("jose", async () => ({
+const {mockImportPKCS8, mockSignJWTConstructor} = vi.hoisted(() => ({
+  mockImportPKCS8: vi.fn(),
+  mockSignJWTConstructor: vi.fn()
+}))
+
+vi.mock("jose", async () => ({
   __esModule: true,
   importPKCS8: mockImportPKCS8,
   SignJWT: mockSignJWTConstructor
@@ -31,7 +34,7 @@ describe("tokenExchange", () => {
   let axiosInstance: AxiosInstance
 
   beforeEach(() => {
-    jest.clearAllMocks()
+    vi.clearAllMocks()
     logger = new Logger({serviceName: "test-service"})
 
     axiosInstance = axios.create({baseURL: host})
@@ -56,7 +59,7 @@ describe("tokenExchange", () => {
       setExpirationTime: function () {
         return this
       },
-      sign: jest.fn().mockImplementation(() => Promise.resolve("signed.jwt.token"))
+      sign: vi.fn().mockImplementation(() => Promise.resolve("signed.jwt.token"))
     }
     mockSignJWTConstructor.mockImplementation(() => fakeJwtInstance)
 
@@ -101,7 +104,7 @@ describe("tokenExchange", () => {
       setExpirationTime() {
         return this
       },
-      sign: jest.fn().mockImplementation(() => Promise.resolve("jwt-tkn"))
+      sign: vi.fn().mockImplementation(() => Promise.resolve("jwt-tkn"))
     }))
 
     nock(`${host}`)
@@ -131,7 +134,7 @@ describe("tokenExchange", () => {
       setExpirationTime() {
         return this
       },
-      sign: jest.fn().mockImplementation(() => Promise.resolve("jwt-tkn"))
+      sign: vi.fn().mockImplementation(() => Promise.resolve("jwt-tkn"))
     }))
 
     nock(`${host}`)
diff --git a/packages/nhsNotifyLambda/tests/testHelpers.ts b/packages/nhsNotifyLambda/tests/testHelpers.ts
@@ -1,25 +1,27 @@
-import {jest} from "@jest/globals"
-
-import * as sqs from "@aws-sdk/client-sqs"
+import {vi} from "vitest"
+import type {Message} from "@aws-sdk/client-sqs"
 
 import {PSUDataItem} from "@psu-common/commonTypes"
 import {NotifyDataItemMessage} from "../src/utils"
 
+const {mockSend} = vi.hoisted(() => ({mockSend: vi.fn()}))
+
+vi.mock("@aws-sdk/client-sqs", async (importOriginal) => {
+  const sqs = await importOriginal<typeof import("@aws-sdk/client-sqs")>()
+  return {
+    ...sqs,
+    SQSClient: vi.fn().mockImplementation(() => ({
+      send: mockSend
+    }))
+  }
+})
+
 // Similarly mock the SQS client
 export function mockSQSClient() {
-  const mockSend = jest.fn()
-  jest.unstable_mockModule("@aws-sdk/client-sqs", () => {
-    return {
-      ...sqs,
-      SQSClient: jest.fn().mockImplementation(() => ({
-        send: mockSend
-      }))
-    }
-  })
   return {mockSend}
 }
 
-export function constructMessage(overrides: Partial<sqs.Message> = {}): sqs.Message {
+export function constructMessage(overrides: Partial<Message> = {}): Message {
   return {
     MessageId: "messageId",
     Attributes: {
diff --git a/packages/nhsNotifyLambda/tests/testNhsNotifyLambda.test.ts b/packages/nhsNotifyLambda/tests/testNhsNotifyLambda.test.ts
@@ -1,30 +1,47 @@
 import {
-  jest,
+  vi,
   describe,
   it,
   beforeAll,
+  beforeEach,
   afterEach
-} from "@jest/globals"
+} from "vitest"
 
 import {constructPSUDataItem, constructPSUDataItemMessage} from "./testHelpers"
 
-const mockGetParameter = jest.fn().mockImplementation(() => "parameter_value")
-jest.unstable_mockModule(
+const {
+  mockGetParameter,
+  mockAddPrescriptionMessagesToNotificationStateStore,
+  mockRemoveSQSMessages,
+  mockReportQueueStatus,
+  mockDrainQueue,
+  mockCheckCooldownForUpdate,
+  mockMakeBatchNotifyRequest,
+  mockInfo,
+  mockError,
+  mockWarn
+} = vi.hoisted(() => ({
+  mockGetParameter: vi.fn().mockImplementation(() => "parameter_value"),
+  mockAddPrescriptionMessagesToNotificationStateStore: vi.fn(),
+  mockRemoveSQSMessages: vi.fn(),
+  mockReportQueueStatus: vi.fn(),
+  mockDrainQueue: vi.fn(),
+  mockCheckCooldownForUpdate: vi.fn(),
+  mockMakeBatchNotifyRequest: vi.fn(),
+  mockInfo: vi.fn(),
+  mockError: vi.fn(),
+  mockWarn: vi.fn()
+}))
+
+vi.mock(
   "@aws-lambda-powertools/parameters/ssm",
   async () => ({
     __esModule: true,
     getParameter: mockGetParameter
   })
 )
 
-const mockAddPrescriptionMessagesToNotificationStateStore = jest.fn()
-const mockRemoveSQSMessages = jest.fn()
-const mockReportQueueStatus = jest.fn()
-const mockDrainQueue = jest.fn()
-const mockCheckCooldownForUpdate = jest.fn()
-const mockMakeBatchNotifyRequest = jest.fn()
-
-jest.unstable_mockModule(
+vi.mock(
   "../src/utils",
   async () => ({
     __esModule: true,
@@ -37,14 +54,11 @@ jest.unstable_mockModule(
   })
 )
 
-const mockInfo = jest.fn()
-const mockError = jest.fn()
-const mockWarn = jest.fn()
-jest.unstable_mockModule(
+vi.mock(
   "@aws-lambda-powertools/logger",
   async () => ({
     __esModule: true,
-    Logger: jest.fn().mockImplementation(() => ({
+    Logger: vi.fn().mockImplementation(() => ({
       info: mockInfo,
       error: mockError,
       warn: mockWarn
@@ -62,11 +76,15 @@ import {mockEventBridgeEvent} from "@psu-common/testing"
 const ORIGINAL_ENV = {...process.env}
 
 describe("Unit test for NHS Notify lambda handler", () => {
+  beforeEach(() => {
+    mockGetParameter.mockReset()
+    mockGetParameter.mockImplementation(() => "parameter_value")
+  })
+
   afterEach(() => {
     process.env = {...ORIGINAL_ENV}
 
-    jest.clearAllMocks()
-    jest.restoreAllMocks()
+    vi.clearAllMocks()
   })
 
   it("When the getParameter call fails, the handler throws an error", async () => {
@@ -293,7 +311,7 @@ describe("Unit test for NHS Notify lambda handler", () => {
       Promise.resolve({messages: [msg], isEmpty: false})
     )
 
-    const nowSpy = jest.spyOn(Date, "now")
+    const nowSpy = vi.spyOn(Date, "now")
       .mockImplementationOnce(() => 0) // start time
       .mockImplementationOnce(() => (14 * 60 * 1000) + 1)
 
diff --git a/packages/nhsNotifyLambda/tests/testSecrets.test.ts b/packages/nhsNotifyLambda/tests/testSecrets.test.ts
@@ -1,7 +1,10 @@
-import {jest} from "@jest/globals"
+import {vi} from "vitest"
 
-const mockGetSecret = jest.fn<() => Promise<string | null>>()
-jest.unstable_mockModule(
+const {mockGetSecret} = vi.hoisted(() => ({
+  mockGetSecret: vi.fn<() => Promise<string | null>>()
+}))
+
+vi.mock(
   "@aws-lambda-powertools/parameters/secrets",
   async () => ({
     __esModule: true,
@@ -16,7 +19,7 @@ describe("loadSecrets", () => {
     process.env.API_KEY_SECRET = "api-key-secret-name"
     process.env.PRIVATE_KEY_SECRET = "private-key-secret-name"
     process.env.KID_SECRET = "kid-secret-name"
-    jest.clearAllMocks()
+    vi.clearAllMocks()
   })
 
   it("should load and trim secrets successfully", async () => {
diff --git a/packages/nhsNotifyLambda/tests/testUtils.test.ts b/packages/nhsNotifyLambda/tests/testUtils.test.ts
diff --git a/packages/nhsNotifyLambda/vitest.config.ts b/packages/nhsNotifyLambda/vitest.config.ts

Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,3 @@`
`1`	`1`	`{`
`2`		`- "jest.jestCommandLine": "/workspaces/eps-prescription-status-update-api/node_modules/.bin/jest --no-cache",`
`3`		`- "jest.nodeEnv": {`
`4`		`- "POWERTOOLS_DEV": true,`
`5`		`- "NODE_OPTIONS": "--experimental-vm-modules"`
`6`		`- }`
	`2`	`+ "testing.automaticallyOpenPeekView": "never"`
`7`	`3`	`}`