Merge pull request #1115 from NHSDigital/feature/SAFO6-NRL-1841-performance-tests-public-mode

Feature/safo6 nrl 1841 performance tests public mode

Author: anjalitrace2-nhs

.github/workflows/pr-env-deploy.yml

@@ -300,10 +300,10 @@ jobs:
         run: make test-performance-prepare TF_WORKSPACE_NAME=${{ needs.set-environment-id.outputs.environment_id }}
 
       - name: Run Performance Test - Baseline
-        run: make test-performance-baseline HOST=${{ needs.set-environment-id.outputs.environment_id }}.api.record-locator.dev.national.nhs.uk ENV_TYPE=dev
+        run: make test-performance-baseline-internal HOST=${{ needs.set-environment-id.outputs.environment_id }}.api.record-locator.dev.national.nhs.uk ENV_TYPE=dev
 
       - name: Run Performance Test - Stress
-        run: make test-performance-stress HOST=${{ needs.set-environment-id.outputs.environment_id }}.api.record-locator.dev.national.nhs.uk ENV_TYPE=dev
+        run: make test-performance-stress-internal HOST=${{ needs.set-environment-id.outputs.environment_id }}.api.record-locator.dev.national.nhs.uk ENV_TYPE=dev
 
       - name: Process Performance Test Outputs
         run: make test-performance-output

Makefile

@@ -21,6 +21,7 @@ PERFTEST_PATIENTS_WITH_POINTERS ?= 0
 PERFTEST_POINTERS_PER_PATIENT ?= 0
 PERFTEST_TYPE_DIST_PROFILE ?= default
 PERFTEST_CUSTODIAN_DIST_PROFILE ?= default
+PERFTEST_TOKEN_REFRESH_PORT ?= 8765
 
 export PATH := $(PATH):$(PWD)/.venv/bin
 export USE_SHARED_RESOURCES := $(shell poetry run python scripts/are_resources_shared_for_stack.py $(TF_WORKSPACE_NAME))
@@ -156,20 +157,58 @@ test-performance-prepare:
 	mkdir -p $(DIST_PATH)
 	PYTHONPATH=. poetry run python tests/performance/environment.py setup $(TF_WORKSPACE_NAME)
 
-test-performance: check-warn test-performance-baseline test-performance-stress ## Run the performance tests
+test-performance-internal: check-warn test-performance-baseline-internal test-performance-stress-internal ## Run the performance tests against the internal access points
 
-test-performance-baseline:
-	@echo "Running consumer performance baseline test"
-	k6 run --out csv=$(DIST_PATH)/consumer-baseline.csv tests/performance/consumer/baseline.js -e HOST=$(HOST) -e ENV_TYPE=$(ENV_TYPE)
-
-test-performance-stress:
-	@echo "Running consumer performance stress test"
+test-performance-baseline-internal: check-warn ## Run the performance baseline tests for the internal access points
+	@echo "Running internal consumer performance baseline test"
+	TEST_CONNECT_MODE=internal \
+	TEST_STACK_DOMAIN=$(shell terraform -chdir=terraform/infrastructure output -raw domain 2>/dev/null) \
+		k6 run --out csv=$(DIST_PATH)/consumer-baseline.csv tests/performance/consumer/baseline.js -e HOST=$(HOST) -e ENV_TYPE=$(ENV_TYPE)
+
+test-performance-baseline-public: check-warn ## Run the baseline performance tests for the external access points
+	@echo "Fetching public mode configuration and bearer token..."
+	@CONFIG_FILE=$$(mktemp /tmp/perf_config_XXXXXX); \
+	trap "rm -f $$CONFIG_FILE" EXIT; \
+	PYTHONPATH=. python3 tests/performance/get_test_config.py $(ENV_TYPE) 2>&1 | tail -n 1 > $$CONFIG_FILE; \
+	PUBLIC_BASE_URL=$$(jq -r '.public_base_url' $$CONFIG_FILE); \
+	echo "Running consumer performance baseline test against the external access points"; \
+	TEST_CONNECT_MODE=public \
+	TEST_PUBLIC_BASE_URL=$$PUBLIC_BASE_URL \
+	TEST_CONFIG_FILE=$$CONFIG_FILE \
+		k6 run --out csv=$(DIST_PATH)/consumer-baseline-public.csv tests/performance/consumer/baseline.js -e ENV_TYPE=$(ENV_TYPE)
+
+test-performance-stress-internal: ## Run the performance stress tests for the internal access points
+	@echo "Running internal consumer performance stress test"
 	k6 run --out csv=$(DIST_PATH)/consumer-stress.csv tests/performance/consumer/stress.js -e HOST=$(HOST) -e ENV_TYPE=$(ENV_TYPE)
 
-test-performance-soak:
-	@echo "Running consumer performance soak test"
+test-performance-stress-public: check-warn ## Run the stress performance tests for the external access points
+	@echo "Fetching public mode configuration and bearer token..."
+	@CONFIG_FILE=$$(mktemp /tmp/perf_config_XXXXXX); \
+	trap "rm -f $$CONFIG_FILE" EXIT; \
+	PYTHONPATH=. python3 tests/performance/get_test_config.py $(ENV_TYPE) 2>&1 | tail -n 1 > $$CONFIG_FILE; \
+	PUBLIC_BASE_URL=$$(jq -r '.public_base_url' $$CONFIG_FILE); \
+	echo "Running consumer performance stress test against the external access points"; \
+	TEST_CONNECT_MODE=public \
+	TEST_PUBLIC_BASE_URL=$$PUBLIC_BASE_URL \
+	TEST_CONFIG_FILE=$$CONFIG_FILE \
+		k6 run --out csv=$(DIST_PATH)/consumer-stress-public.csv tests/performance/consumer/stress.js -e ENV_TYPE=$(ENV_TYPE)
+
+test-performance-soak-internal:
+	@echo "Running internal consumer performance soak test"
 	k6 run --out csv=$(DIST_PATH)/consumer-soak.csv tests/performance/consumer/soak.js -e HOST=$(HOST) -e ENV_TYPE=$(ENV_TYPE)
 
+test-performance-soak-public: check-warn ## Run the soak performance tests for the external access points
+	@echo "Fetching public mode configuration and bearer token..."
+	@CONFIG_FILE=$$(mktemp /tmp/perf_config_XXXXXX); \
+	trap "rm -f $$CONFIG_FILE" EXIT; \
+	PYTHONPATH=. python3 tests/performance/get_test_config.py $(ENV_TYPE) 2>&1 | tail -n 1 > $$CONFIG_FILE; \
+	PUBLIC_BASE_URL=$$(jq -r '.public_base_url' $$CONFIG_FILE); \
+	echo "Running consumer performance soak test against the external access points"; \
+	TEST_CONNECT_MODE=public \
+	TEST_PUBLIC_BASE_URL=$$PUBLIC_BASE_URL \
+	TEST_CONFIG_FILE=$$CONFIG_FILE \
+		k6 run --out csv=$(DIST_PATH)/consumer-soak-public.csv tests/performance/consumer/soak.js -e ENV_TYPE=$(ENV_TYPE)
+
 test-performance-output: ## Process outputs from the performance tests
 	@echo "Processing performance test outputs"
 	poetry run python tests/performance/process_results.py baseline $(DIST_PATH)/consumer-baseline.csv
@@ -254,6 +293,7 @@ generate-models: check-warn ## Generate Pydantic Models
 
 
 perftest-generate-permissions: ## Generate perftest permissions and add to nrlf_permissions
+	@echo "Generating permissions for performance tests with DIST_PATH=$(DIST_PATH)"
 	PYTHONPATH=. poetry run python tests/performance/producer/generate_permissions.py --output_dir="$(DIST_PATH)/nrlf_permissions/K6PerformanceTest"
 
 perftest-seed-tables:	## Seed tables and upload generated perftest input files to s3
@@ -270,22 +310,61 @@ perftest-prepare:	## Prepare input files for producer & consumer perf tests
 	mkdir -p "${DIST_PATH}/nft"
 	aws s3 cp "s3://nhsd-nrlf--${ENV}-metadata/performance/seed-pointers-extract-${PERFTEST_TABLE_NAME}.zip" "${DIST_PATH}/pointer_extract-${PERFTEST_TABLE_NAME}.zip"
 	unzip "${DIST_PATH}/pointer_extract-${PERFTEST_TABLE_NAME}.zip"
-# 	cp "${DIST_PATH}/nft/seed-pointers-extract-${PERFTEST_TABLE_NAME}.csv" "${DIST_PATH}/seed-pointers-extract.csv"
 	PYTHONPATH=. poetry run python ./tests/performance/generate_producer_distributions.py
 
-perftest-producer:	## Run producer perf tests
+perftest-producer-internal:	## Run producer perf tests
 	@echo "Running producer performance tests with HOST=$(PERFTEST_HOST) and ENV_TYPE=$(ENV_TYPE) and DIST_PATH=$(DIST_PATH)"
 	k6 run tests/performance/producer/perftest.js -e HOST=$(PERFTEST_HOST) -e ENV_TYPE=$(ENV_TYPE) -e DIST_PATH=$(DIST_PATH)
 
-perftest-consumer:	## Run consumer perf tests
+perftest-producer-public: check-warn ## Run the producer perftests for the external access points
+	@echo "Starting token refresher in background with ENV=$(ENV) PERFTEST_TOKEN_REFRESH_PORT=$(PERFTEST_TOKEN_REFRESH_PORT)"
+	ENV=$(ENV) TOKEN_REFRESH_PORT=$(PERFTEST_TOKEN_REFRESH_PORT) PYTHONPATH=. poetry run python ./tests/performance/token_refresher.py &
+	trap "kill $$(lsof -t -i :$(PERFTEST_TOKEN_REFRESH_PORT)) 2>/dev/null" EXIT
+	@echo "Fetching public mode configuration..."
+	@CONFIG_FILE=$$(mktemp /tmp/perf_config_XXXXXX); \
+	trap "rm -f $$CONFIG_FILE" EXIT; \
+	PYTHONPATH=. poetry run python tests/performance/get_test_config.py $(ENV_TYPE) 2>&1 | tail -n 1 > $$CONFIG_FILE; \
+	PUBLIC_BASE_URL=$$(jq -r '.public_base_url' $$CONFIG_FILE); \
+	echo "Running public producer perftests with ENV_TYPE=$(ENV_TYPE) and DIST_PATH=$(DIST_PATH)"; \
+	TEST_CONNECT_MODE=public \
+	TEST_PUBLIC_BASE_URL=$$PUBLIC_BASE_URL \
+	TEST_CONFIG_FILE=$$CONFIG_FILE \
+		k6 run tests/performance/producer/perftest.js -e ENV_TYPE=$(ENV_TYPE) -e DIST_PATH=$(DIST_PATH)
+	kill $$(lsof -t -i :$(PERFTEST_TOKEN_REFRESH_PORT))
+
+perftest-consumer-internal:
 	@echo "Running consumer performance tests with HOST=$(PERFTEST_HOST) and ENV_TYPE=$(ENV_TYPE) and DIST_PATH=$(DIST_PATH)"
 	k6 run tests/performance/consumer/perftest.js -e HOST=$(PERFTEST_HOST) -e ENV_TYPE=$(ENV_TYPE) -e DIST_PATH=$(DIST_PATH)
 
-perftest-generate-pointer-table-extract:	## Refresh the perf test input files in s3. Can be expensive to run on large tables
+perftest-consumer-public: check-warn ## Run the consumer perftests for the external access points
+	@echo "Starting token refresher in background with ENV=$(ENV) PERFTEST_TOKEN_REFRESH_PORT=$(PERFTEST_TOKEN_REFRESH_PORT)"
+	ENV=$(ENV) TOKEN_REFRESH_PORT=$(PERFTEST_TOKEN_REFRESH_PORT) PYTHONPATH=. poetry run python ./tests/performance/token_refresher.py &
+	trap "kill $$(lsof -t -i :$(PERFTEST_TOKEN_REFRESH_PORT)) 2>/dev/null" EXIT
+	@echo "Fetching public mode configuration..."
+	@CONFIG_FILE=$$(mktemp /tmp/perf_config_XXXXXX); \
+	trap "rm -f $$CONFIG_FILE" EXIT; \
+	PYTHONPATH=. poetry run python tests/performance/get_test_config.py $(ENV_TYPE) 2>&1 | tail -n 1 > $$CONFIG_FILE; \
+	PUBLIC_BASE_URL=$$(jq -r '.public_base_url' $$CONFIG_FILE); \
+	echo "Running public consumer perftests with ENV_TYPE=$(ENV_TYPE) and DIST_PATH=$(DIST_PATH)"; \
+	TEST_CONNECT_MODE=public \
+	TEST_PUBLIC_BASE_URL=$$PUBLIC_BASE_URL \
+	TEST_CONFIG_FILE=$$CONFIG_FILE \
+		k6 run tests/performance/consumer/perftest.js -e ENV_TYPE=$(ENV_TYPE) -e DIST_PATH=$(DIST_PATH)
+	kill $$(lsof -t -i :$(PERFTEST_TOKEN_REFRESH_PORT))
+
+perftest-generate-pointer-table-extract:
 	@echo "Generating pointer table extract with PERFTEST_TABLE_NAME=$(PERFTEST_TABLE_NAME) and DIST_PATH=$(DIST_PATH)"
 	rm -rf "${DIST_PATH}/nft"
 	mkdir -p "${DIST_PATH}/nft"
 	PYTHONPATH=. poetry run python tests/performance/perftest_environment.py generate_pointer_table_extract --output_dir="${DIST_PATH}/nft"
 	./scripts/get-current-info.sh > "${DIST_PATH}/nft/info.json"
 	zip -r "${DIST_PATH}/pointer_extract-${PERFTEST_TABLE_NAME}.zip" "${DIST_PATH}/nft"
 	aws s3 cp "${DIST_PATH}/pointer_extract-${PERFTEST_TABLE_NAME}.zip" "s3://nhsd-nrlf--${ENV}-metadata/performance/seed-pointers-extract-${PERFTEST_TABLE_NAME}.zip"
+
+perftest-run-token-refresher:
+	@echo "Starting token refresher in background with ENV=$(ENV) PERFTEST_TOKEN_REFRESH_PORT=$(PERFTEST_TOKEN_REFRESH_PORT)"
+	ENV=$(ENV) TOKEN_REFRESH_PORT=$(PERFTEST_TOKEN_REFRESH_PORT) PYTHONPATH=. poetry run python ./tests/performance/token_refresher.py &
+	trap "kill $$(lsof -t -i :$(PERFTEST_TOKEN_REFRESH_PORT)) 2>/dev/null" EXIT
+
+	make perftest-consumer-public
+	kill $$(lsof -t -i :$(PERFTEST_TOKEN_REFRESH_PORT))

tests/performance/README.md

@@ -50,7 +50,8 @@ You will need to generate pointer permissions the first time performance tests a
 ```sh
 # In project root
 make perftest-generate-permissions   # makes a bunch of json permission files for test organisations
-make build  # will take all permissions & create nrlf_permissions.zip file
+make get-s3-perms ENV=perftest   # will take all permissions & create nrlf_permissions.zip file
+make build
 
 # apply this new permissions zip file to your environment
 cd ./terraform/infrastructure
@@ -71,11 +72,26 @@ make perftest-prepare PERFTEST_TABLE_NAME=nhsd-nrlf--perftest-baseline-pointers-
 
 ### Run tests
 
+#### Internal mode
+
 ```sh
-make perftest-consumer ENV_TYPE=perftest PERFTEST_HOST=perftest-1.perftest.record-locator.national.nhs.uk
-make perftest-producer ENV_TYPE=perftest PERFTEST_HOST=perftest-1.perftest.record-locator.national.nhs.uk
+assume nhsd-nrlf-test
+make perftest-consumer-internal ENV_TYPE=perftest PERFTEST_HOST=perftest-1.perftest.record-locator.national.nhs.uk
+make perftest-producer-internal ENV_TYPE=perftest PERFTEST_HOST=perftest-1.perftest.record-locator.national.nhs.uk
 ```
 
+#### Public mode
+
+Via apigee proxies - most similar to a supplier. Spins up a local http server in background responsible for refreshing bearer token (valid for 5 mins each).
+
+```sh
+assume nhsd-nrlf-mgmt
+make perftest-consumer-public ENV=perftest
+make perftest-producer-public ENV=perftest
+```
+
+> Troubleshooting: seeing an unprompted message like "Token refreshed at Mon Jan 19 16:43:35 2026" pop up in your terminal after the test run? The background token server is still going. To resolve, kill the server process with `kill $(lsof -t -i :8765)` (replacing 8765 with your custom port if you specified one).
+
 ## Seed data
 
 Must be run on an empty table. Cannot top up an existing set of pointers.

tests/performance/constants.js

@@ -17,7 +17,7 @@ export const NHS_NUMBERS = REFERENCE_DATA["nhs_numbers"];
 
 // filter only 736253001, 736253002, 1363501000000100, 861421000000109, 749001000000101 for now
 export const FILTERED_POINTER_TYPES = [
-  "736253001",
+  // "736253001",
   "736253002",
   "1363501000000100",
   "861421000000109",

tests/performance/consumer/client.js

@@ -1,32 +1,14 @@
+import { getHeaders, getFullUrl } from "../test-config.js";
 import {
+  POINTER_TYPES,
+  CATEGORIES,
   NHS_NUMBERS,
   POINTER_IDS,
-  POINTER_TYPES,
   ODS_CODE,
-  CATEGORIES,
 } from "../constants.js";
 import http from "k6/http";
 import { check } from "k6";
 
-function getHeaders(odsCode = ODS_CODE) {
-  return {
-    "Content-Type": "application/fhir+json",
-    "X-Request-Id": "K6PerformanceTest",
-    "NHSD-Correlation-Id": "K6PerformanceTest",
-    "NHSD-Connection-Metadata": JSON.stringify({
-      "nrl.ods-code": odsCode,
-      "nrl.pointer-types": POINTER_TYPES.map(
-        (type) => `http://snomed.info/sct|${type}`
-      ),
-      "nrl.app-id": "K6PerformanceTest",
-    }),
-    "NHSD-Client-RP-Details": JSON.stringify({
-      "developer.app.name": "K6PerformanceTest",
-      "developer.app.id": "K6PerformanceTest",
-    }),
-  };
-}
-
 function checkResponse(res) {
   const is_success = check(res, { "status is 200": (r) => r.status === 200 });
   if (!is_success) {
@@ -41,25 +23,22 @@ export function countDocumentReference() {
   const identifier = encodeURIComponent(
     `https://fhir.nhs.uk/Id/nhs-number|${nhsNumber}`
   );
-  const res = http.get(
-    `https://${__ENV.HOST}/consumer/DocumentReference?_summary=count&subject:identifier=${identifier}`,
-    {
-      headers: getHeaders(),
-    }
-  );
+
+  const path = `/DocumentReference?_summary=count&subject:identifier=${identifier}`;
+  const res = http.get(getFullUrl(path, "consumer"), {
+    headers: getHeaders(ODS_CODE, "consumer"),
+  });
   checkResponse(res);
 }
 
 export function readDocumentReference() {
   const choice = Math.floor(Math.random() * POINTER_IDS.length);
   const id = POINTER_IDS[choice];
 
-  const res = http.get(
-    `https://${__ENV.HOST}/consumer/DocumentReference/${id}`,
-    {
-      headers: getHeaders(),
-    }
-  );
+  const path = `/DocumentReference/${id}`;
+  const res = http.get(getFullUrl(path, "consumer"), {
+    headers: getHeaders(ODS_CODE, "consumer"),
+  });
 
   checkResponse(res);
 }
@@ -74,12 +53,10 @@ export function searchDocumentReference() {
   );
   const type = encodeURIComponent(`http://snomed.info/sct|${pointer_type}`);
 
-  const res = http.get(
-    `https://${__ENV.HOST}/consumer/DocumentReference?subject:identifier=${identifier}&type=${type}`,
-    {
-      headers: getHeaders(),
-    }
-  );
+  const path = `/DocumentReference?subject:identifier=${identifier}&type=${type}`;
+  const res = http.get(getFullUrl(path, "consumer"), {
+    headers: getHeaders(ODS_CODE, "consumer"),
+  });
   checkResponse(res);
 }
 
@@ -95,12 +72,10 @@ export function searchDocumentReferenceByCategory() {
     `http://snomed.info/sct|${randomCategory}`
   );
 
-  const res = http.get(
-    `https://${__ENV.HOST}/consumer/DocumentReference?subject:identifier=${identifier}&category=${category}`,
-    {
-      headers: getHeaders(),
-    }
-  );
+  const path = `/DocumentReference?subject:identifier=${identifier}&category=${category}`;
+  const res = http.get(getFullUrl(path, "consumer"), {
+    headers: getHeaders(ODS_CODE, "consumer"),
+  });
   checkResponse(res);
 }
 
@@ -114,13 +89,10 @@ export function searchPostDocumentReference() {
     type: `http://snomed.info/sct|${pointer_type}`,
   });
 
-  const res = http.post(
-    `https://${__ENV.HOST}/consumer/DocumentReference/_search`,
-    body,
-    {
-      headers: getHeaders(),
-    }
-  );
+  const path = `/DocumentReference/_search`;
+  const res = http.post(getFullUrl(path, "consumer"), body, {
+    headers: getHeaders(ODS_CODE, "consumer"),
+  });
   checkResponse(res);
 }
 
@@ -133,13 +105,10 @@ export function searchPostDocumentReferenceByCategory() {
     category: `http://snomed.info/sct|${category}`,
   });
 
-  const res = http.post(
-    `https://${__ENV.HOST}/consumer/DocumentReference/_search`,
-    body,
-    {
-      headers: getHeaders(),
-    }
-  );
+  const path = `/DocumentReference/_search`;
+  const res = http.post(getFullUrl(path, "consumer"), body, {
+    headers: getHeaders(ODS_CODE, "consumer"),
+  });
   checkResponse(res);
 }
 
@@ -150,12 +119,10 @@ export function countPostDocumentReference() {
   const body = JSON.stringify({
     "subject:identifier": `https://fhir.nhs.uk/Id/nhs-number|${nhsNumber}`,
   });
-  const res = http.post(
-    `https://${__ENV.HOST}/consumer/DocumentReference/_search?_summary=count`,
-    body,
-    {
-      headers: getHeaders(),
-    }
-  );
+
+  const path = `/DocumentReference/_search?_summary=count`;
+  const res = http.post(getFullUrl(path, "consumer"), body, {
+    headers: getHeaders(ODS_CODE, "consumer"),
+  });
   checkResponse(res);
 }