Allow to run performance tests against staging

.ops/performance-test/.gitignore

@@ -1,2 +1,4 @@
+/measurements
+!/measurements/.gitkeep
 /node_modules
 .env

.ops/performance-test/README.md

@@ -6,6 +6,23 @@ Run tests
 docker compose run --rm performance-test run --quiet script.js | jq --sort-keys > output.json
 ```
 
+Run tests
+
+```shell
+API_ROOT_URL="http://localhost:3000"
+
+env_file=.env
+
+if [ -f "$env_file" ]; then
+  API_ROOT_URL=$(grep '^API_ROOT_URL=' "$env_file" | cut -d '=' -f 2 | tr -d '\r')
+fi
+
+datetime=$(date -u +"%Y-%m-%dT%H:%M:%SZ")
+filename=$(printf "%s" "$API_ROOT_URL" | sed 's|https?://||; s|/|_|g')_$datetime.json
+
+docker compose run --rm performance-test run --quiet script.js | jq --sort-keys > measurements/$filename
+```
+
 Run tests once to debug
 
 

.ops/performance-test/script.js

@@ -1,6 +1,8 @@
+import encoding from 'k6/encoding'
 import http from 'k6/http'
 import { Trend } from 'k6/metrics'
 
+// noinspection JSUnusedGlobalSymbols
 export const options = {
   // A number specifying the number of VUs to run concurrently.
   vus: __ENV.VUS || 10,
@@ -11,6 +13,15 @@ export const options = {
 
 const host = __ENV.API_ROOT_URL || 'http://localhost:3000'
 
+const basicAuthUser = __ENV.BASIC_AUTH_USER
+const basicAuthPassword = __ENV.BASIC_AUTH_PASSWORD
+
+if (!!basicAuthUser !== !!basicAuthPassword) {
+  throw new Error('BASIC_AUTH_USER and BASIC_AUTH_PASSWORD must be set together')
+}
+
+const basicAuthActive = !!basicAuthUser && !!basicAuthPassword
+
 const specialEndpoints = [
   '/',
   '/api',
@@ -45,20 +56,20 @@ export default function() {
   const loginResponse = http.post(
     `${host}/api/authentication_token`,
     payload,
-    { headers: { 'Content-Type': 'application/json' } })
+    { headers: addAuthorizationHeadersIfNecessary({ 'Content-Type': 'application/json' }) })
   loginTrend.add(loginResponse.timings.duration);
 
   for (const [_, value] of Object.entries(getUrlsToMeasure()._links)) {
     const urlWithoutTemplate = value.href.replace(/{.*$/, '')
     if (!specialEndpoints.includes(urlWithoutTemplate)) {
       const url = `${host}${urlWithoutTemplate}.jsonhal`
-      const collection = http.get(url)
+      const collection = http.get(url, { headers: addAuthorizationHeadersIfNecessary() })
 
       metricsMap.get(urlWithoutTemplate)?.add(collection.timings.duration)
 
       try {
         const itemUrl = JSON.parse(collection.body)._embedded?.items[0]._links.self.href
-        const itemResponse = http.get(`${host}${itemUrl}.jsonhal`)
+        const itemResponse = http.get(`${host}${itemUrl}.jsonhal`, { headers: addAuthorizationHeadersIfNecessary() })
         metricsMap.get(`${urlWithoutTemplate}/item`)?.add(itemResponse.timings.duration)
       }
       // this also catches the ReferenceError on the long path to find the item url
@@ -228,3 +239,14 @@ function getUrlsToMeasure() {
 function toMetricName(name) {
   return name.replaceAll("/", "_")
 }
+
+function addAuthorizationHeadersIfNecessary(headers = {}) {
+  const authHeaders = {}
+  if (basicAuthActive) {
+    authHeaders['Authorization'] =  `Basic ${encoding.b64encode(`${basicAuthUser}:${basicAuthPassword}`)}`
+  }
+  return {
+    ...authHeaders,
+    ...headers
+  }
+}