address PR comments

Author: Vlasis-Perdikidis

.gitleaksignore

@@ -23,7 +23,6 @@ e12407e09151898bfd8d049d57eee9db9977d56b:.github/copilot-instructions.md:generic
 debc75a97cfe551a69fd1e8694be483213322a9d:pact-contracts/pacts/letter-rendering/supplier-api-letter-request-prepared.json:generic-api-key:10
 793b2ab7a3e698f5848fbe24d2718f88664ec0fc:.npmrc:npm-access-token:8
 793b2ab7a3e698f5848fbe24d2718f88664ec0fc:.npmrc:github-pat:6
-777eb4047ad06b9e939a292ee18664a0ffee4f29:tests/resources/prepared-letter.json:generic-api-key:4
 d005112adcfd286c3bef076214836dbb2fe8d0b5:.npmrc:github-pat:7
 d005112adcfd286c3bef076214836dbb2fe8d0b5:.npmrc:npm-access-token:9
 4fa1923947bbff2387218d698d766cbb7c121a0f:pact-contracts/pacts/letter-rendering/supplier-api-letter-request-prepared.json:generic-api-key:10

package-lock.json

@@ -1,25 +1,42 @@
 import fs from "node:fs";
 import path from "node:path";
-import { envName } from "tests/constants/api-constants";
+import { UPSERT_LETTER_LAMBDA_ARN } from "tests/constants/api-constants";
 import { getLambdaEnv, updateLambdaEnv } from "tests/helpers/aws-lambda-helper";
 import { logger } from "tests/helpers/pino-logger";
 
-const ORIGINAL_ENV = path.join(__dirname, ".lambda-env.json");
-const UPSERT_LETTER_LAMBDA_ARN = `arn:aws:lambda:eu-west-2:820178564574:function:nhs-${envName}-supapi-upsertletter`;
+const ORIGINAL_ENV = path.join(
+  __dirname,
+  "..",
+  "..",
+  "resources",
+  "lambda-env.json",
+);
 
 export default async function performanceSetup() {
-  const currentEnv = await getLambdaEnv(UPSERT_LETTER_LAMBDA_ARN);
-  if (Object.keys(currentEnv).length === 0) {
-    return;
-  }
+  try {
+    const currentEnv = await getLambdaEnv(UPSERT_LETTER_LAMBDA_ARN);
+    if (Object.keys(currentEnv).length === 0) {
+      throw new Error(
+        `unable to obtain configuration environment for Lambda function ${UPSERT_LETTER_LAMBDA_ARN}. Exiting performance-setup`,
+      );
+    }
+
+    // Persist original env for teardown
+    fs.writeFileSync(ORIGINAL_ENV, JSON.stringify(currentEnv, null, 2));
 
-  // Persist original env for teardown
-  fs.writeFileSync(ORIGINAL_ENV, JSON.stringify(currentEnv, null, 2));
+    // if original env not persisted throw error, as we can't restore the env during teardown
+    if (!fs.existsSync(ORIGINAL_ENV)) {
+      throw new Error(`Setup failed: original Lambda env was not persisted at ${ORIGINAL_ENV}, so the Lambda environment was NOT stored.
+      Try running the test again`);
+    }
 
-  await updateLambdaEnv(UPSERT_LETTER_LAMBDA_ARN, {
-    ...currentEnv,
-    LETTER_TTL_HOURS: "1",
-  });
+    await updateLambdaEnv(UPSERT_LETTER_LAMBDA_ARN, {
+      ...currentEnv,
+      LETTER_TTL_HOURS: "1",
+    });
 
-  logger.info("LETTER_TTL_HOURS set to 1");
+    logger.info("LETTER_TTL_HOURS set to 1");
+  } catch (error) {
+    throw new Error(`Performance tests setup failed with error: ${error}`);
+  }
 }

tests/config/performance/performance-setup.ts

@@ -1,21 +1,38 @@
 import fs from "node:fs";
-import { envName } from "tests/constants/api-constants";
+import { UPSERT_LETTER_LAMBDA_ARN } from "tests/constants/api-constants";
 import { updateLambdaEnv } from "tests/helpers/aws-lambda-helper";
 import path from "node:path";
 import { logger } from "tests/helpers/pino-logger";
 
-const ORIGINAL_ENV = path.join(__dirname, ".lambda-env.json");
-const UPSERT_LETTER_LAMBDA_ARN = `arn:aws:lambda:eu-west-2:820178564574:function:nhs-${envName}-supapi-upsertletter`;
+const ORIGINAL_ENV = path.join(
+  __dirname,
+  "..",
+  "..",
+  "resources",
+  "lambda-env.json",
+);
 
 export default async function performanceTeardown() {
-  if (!fs.existsSync(ORIGINAL_ENV)) {
-    return;
-  }
+  try {
+    if (!fs.existsSync(ORIGINAL_ENV)) {
+      throw new Error(`Teardown failed: original Lambda env file not found at ${ORIGINAL_ENV}, so the Lambda environment was NOT restored.
+      Either run the test again, or manually set the Original Lambda environment (default LETTER_TLL_HOURS=12960)`);
+    }
 
-  const originalEnv = JSON.parse(fs.readFileSync(ORIGINAL_ENV, "utf8"));
+    const originalEnv = JSON.parse(fs.readFileSync(ORIGINAL_ENV, "utf8"));
 
-  await updateLambdaEnv(UPSERT_LETTER_LAMBDA_ARN, originalEnv);
-  fs.unlinkSync(ORIGINAL_ENV);
+    const response = await updateLambdaEnv(
+      UPSERT_LETTER_LAMBDA_ARN,
+      originalEnv,
+    );
+    if (response.$metadata.httpStatusCode !== 200) {
+      throw new Error(`Teardown failed: with code: ${response.$metadata.httpStatusCode}, while updating Lambda configuration environment from the file ${ORIGINAL_ENV} for function ${UPSERT_LETTER_LAMBDA_ARN}
+      Either run the test again, or update the configuration manually.`);
+    }
 
-  logger.info("Original value of LETTER_TTL_HOURS restored");
+    fs.unlinkSync(ORIGINAL_ENV);
+    logger.info("Original value of LETTER_TTL_HOURS restored");
+  } catch (error) {
+    throw new Error(`Performance tests teardown failed with error: ${error}`);
+  }
 }

tests/config/performance/performance-teardown.ts

@@ -8,3 +8,4 @@ export const LETTERSTABLENAME = `nhs-${envName}-supapi-letters`;
 export const SUPPLIERID = "TestSupplier1";
 export const MI_ENDPOINT = "mi";
 export const SUPPLIERTABLENAME = `nhs-${envName}-supapi-suppliers`;
+export const UPSERT_LETTER_LAMBDA_ARN = `arn:aws:lambda:eu-west-2:820178564574:function:nhs-${envName}-supapi-upsertletter`;

tests/constants/api-constants.ts

@@ -12,10 +12,11 @@ import { AWS_REGION } from "tests/constants/api-constants";
 export const kinesisClient = new KinesisClient({ region: AWS_REGION });
 
 /**
- * Wait for a matching record on a Kinesis stream.
+ * Get all records from a given start time for the specified Kinesis Stream.
+ * Any records before the given start time will be ignored
  *
  * @param streamARN - existing Kinesis stream ARN
- * @param opts - optional settings
+ * @param startTimeMs - Start Time in milliseconds
  */
 export async function retrieveKinesisRecordsAtTimestamp(
   streamARN: string,

tests/helpers/aws-kinesis-helper.ts

@@ -24,7 +24,7 @@ export async function updateLambdaEnv(
   functionArn: string,
   variables: Record<string, string>,
 ) {
-  await lambdaClient.send(
+  return await lambdaClient.send(
     new UpdateFunctionConfigurationCommand({
       FunctionName: functionArn,
       Environment: { Variables: variables },

tests/helpers/aws-lambda-helper.ts

@@ -8,6 +8,7 @@ import { retrieveKinesisRecordsAtTimestamp } from "tests/helpers/aws-kinesis-hel
 import { logger } from "tests/helpers/pino-logger";
 import { envName } from "tests/constants/api-constants";
 import PREPARED_LETTER from "../../resources/prepared-letter.json";
+import { assert } from "console";
 
 test.describe("Performance test checking how long it takes letter requests from the EventSub SNS to reach the Letters Database ", () => {
   test("send 2500 letter requests", async () => {

tests/performance/testCases/send-prepared-letter-request.spec.ts

@@ -1,7 +1,7 @@
 {
   "data": {
     "campaignId": "campaign_456",
-    "clientId": "00f3b388-bbe9-41c9-9e76-052d37ee8988",
+    "clientId": "testClientId",
     "createdAt": "2025-08-28T08:45:00.000Z",
     "domainId": "letter1",
     "letterVariantId": "lv1",