working prepared letter performance test

Author: Vlasis-Perdikidis

Makefile

@@ -103,6 +103,9 @@ config:: _install-dependencies version # Configure development environment (main
 test-component:
 	(cd tests && npm install && npm run test:component)
 
+test-performance:
+	(cd tests && npm install && npm run test:performance)
+
 version:
 	rm -f .version
 	make version-create-effective-file dir=.

package-lock.json

@@ -0,0 +1,25 @@
+import fs from "node:fs";
+import path from "node:path";
+import { envName } 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`;
+
+export default async function performanceSetup() {
+  const currentEnv = await getLambdaEnv(UPSERT_LETTER_LAMBDA_ARN);
+  if (Object.keys(currentEnv).length === 0) {
+    return;
+  }
+
+  // Persist original env for teardown
+  fs.writeFileSync(ORIGINAL_ENV, JSON.stringify(currentEnv, null, 2));
+
+  await updateLambdaEnv(UPSERT_LETTER_LAMBDA_ARN, {
+    ...currentEnv,
+    LETTER_TTL_HOURS: "1",
+  });
+
+  logger.info("LETTER_TTL_HOURS set to 1");
+}

tests/component-tests/testCases/create-letter-request.spec.ts

@@ -0,0 +1,21 @@
+import fs from "node:fs";
+import { envName } 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`;
+
+export default async function performanceTeardown() {
+  if (!fs.existsSync(ORIGINAL_ENV)) {
+    return;
+  }
+
+  const originalEnv = JSON.parse(fs.readFileSync(ORIGINAL_ENV, "utf-8"));
+
+  await updateLambdaEnv(UPSERT_LETTER_LAMBDA_ARN, originalEnv);
+  fs.unlinkSync(ORIGINAL_ENV);
+
+  logger.info("Original value of LETTER_TTL_HOURS restored");
+}

tests/config/performance/performance-setup.ts

@@ -0,0 +1,21 @@
+import type { PlaywrightTestConfig } from "@playwright/test";
+import path from "node:path";
+import { config as baseConfig } from "../playwright.base.config";
+import { getReporters } from "../reporters";
+
+const localConfig: PlaywrightTestConfig = {
+  /* Reporter to use. See https://playwright.dev/docs/test-reporters */
+  reporter: getReporters("api-test"),
+  ...baseConfig,
+  globalSetup: path.resolve(__dirname, "./performance-setup.ts"),
+  globalTeardown: path.resolve(__dirname, "./performance-teardown.ts"),
+  projects: [
+    {
+      name: "performance",
+      testDir: path.resolve(__dirname, "../../performance"),
+      testMatch: "*.spec.ts",
+    },
+  ],
+};
+
+export default localConfig;

tests/config/performance/performance-teardown.ts

@@ -0,0 +1,5 @@
+#!/usr/bin/bash
+
+allure generate allure-results --clean
+allure open allure-report
+

tests/config/performance/performance.config.ts

@@ -0,0 +1,73 @@
+import {
+  GetRecordsCommand,
+  GetRecordsCommandOutput,
+  GetShardIteratorCommand,
+  KinesisClient,
+  ListShardsCommand,
+  Shard,
+  ShardIteratorType,
+} from "@aws-sdk/client-kinesis";
+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.
+ *
+ * @param streamARN - existing Kinesis stream ARN
+ * @param opts - optional settings
+ */
+export async function retrieveKinesisRecordsAtTimestamp(
+  streamARN: string,
+  startTimeMs: number,
+): Promise<number> {
+  let recordsFound = 0;
+
+  const shards: Shard[] = await getShards(streamARN);
+  for (const shard of shards) {
+    recordsFound += await getAllShardRecords(shard, streamARN, startTimeMs);
+  }
+  return recordsFound;
+}
+
+async function getShards(streamARN: string) {
+  const shardsResp = await kinesisClient.send(
+    new ListShardsCommand({ StreamARN: streamARN }),
+  );
+  const shards: Shard[] = shardsResp.Shards ?? [];
+  if (shards.length === 0) {
+    throw new Error(`No shards found for stream ${streamARN}`);
+  }
+  return shards;
+}
+
+async function getAllShardRecords(
+  shard: Shard,
+  streamARN: string,
+  startTimeMs: number,
+) {
+  let shardRecords = 0;
+  const iteratorResponse = await kinesisClient.send(
+    new GetShardIteratorCommand({
+      StreamARN: streamARN,
+      ShardId: shard.ShardId,
+      ShardIteratorType: ShardIteratorType.AT_TIMESTAMP,
+      Timestamp: new Date(startTimeMs),
+    }),
+  );
+
+  const shardIterator = iteratorResponse.ShardIterator;
+  if (!shardIterator) {
+    throw new Error("Failed to obtain shard iterator");
+  }
+
+  const recResp: GetRecordsCommandOutput = await kinesisClient.send(
+    new GetRecordsCommand({
+      ShardIterator: shardIterator,
+      StreamARN: streamARN,
+    }),
+  );
+  shardRecords += recResp.Records?.length ?? 0;
+
+  return shardRecords;
+}

tests/generateAllureReport.sh

@@ -0,0 +1,33 @@
+import {
+  LambdaClient,
+  GetFunctionConfigurationCommandOutput,
+  GetFunctionConfigurationCommand,
+  UpdateFunctionConfigurationCommand,
+} from "@aws-sdk/client-lambda";
+import { AWS_REGION } from "tests/constants/api-constants";
+
+const lambdaClient = new LambdaClient({ region: AWS_REGION });
+
+export async function getLambdaEnv(
+  functionArn: string,
+): Promise<Record<string, string>> {
+  const response: GetFunctionConfigurationCommandOutput =
+    await lambdaClient.send(
+      new GetFunctionConfigurationCommand({
+        FunctionName: functionArn,
+      }),
+    );
+  return response.Environment?.Variables ?? {};
+}
+
+export async function updateLambdaEnv(
+  functionArn: string,
+  variables: Record<string, string>,
+) {
+  await lambdaClient.send(
+    new UpdateFunctionConfigurationCommand({
+      FunctionName: functionArn,
+      Environment: { Variables: variables },
+    }),
+  );
+}

tests/helpers/aws-kinesis-helper.ts

@@ -0,0 +1,5 @@
+import { SNSClient } from "@aws-sdk/client-sns";
+import { AWS_REGION } from "tests/constants/api-constants";
+import { logger } from "./pino-logger";
+
+export const snsClient = new SNSClient({ region: AWS_REGION });