Add k6 performance tests (#3193)

Author: rhysyngsun

.gitignore

@@ -117,6 +117,8 @@ frontends/.yarn
 
 .yarn/*
 !.yarn/releases
+load_testing/.yarn/*
+!load_testing/.yarn/releases
 
 # Typescript
 tsconfig.tsbuildinfo

.pre-commit-config.yaml

@@ -104,7 +104,7 @@ repos:
         language: node
         types_or: [javascript, jsx, ts, tsx]
         args: []
-        exclude: "(node_modules/|.yarn/)"
+        exclude: "(node_modules/|.yarn/|load_testing/)"
         require_serial: false
         additional_dependencies:
           - eslint@8

docker-compose.services.yml

@@ -76,7 +76,7 @@ services:
     ports:
       - "8089:8089"
     volumes:
-      - ./load_testing:/mnt/locust
+      - ./load_testing_locust:/mnt/locust
     command: -f /mnt/locust/locustfile.py --master -H http://nginx:8063 --class-picker
     links:
       - nginx
@@ -86,7 +86,7 @@ services:
   locust-worker:
     image: locustio/locust
     volumes:
-      - ./load_testing:/mnt/locust
+      - ./load_testing_locust:/mnt/locust
     command: -f /mnt/locust/locustfile.py --worker --master-host locust
     links:
       - nginx

load_testing/.stylelintrc.yaml

@@ -0,0 +1,11 @@
+extends:
+  - stylelint-config-standard
+rules:
+  selector-class-pattern:
+    - (^ck.*)|((^Mui[A-Z-])|^([a-z][a-z0-9]*)((-|__?)[a-z0-9]+)*$) # CKEditor, MUI or kebab-case
+    - message: "Expected class selector to be kebab-case"
+overrides:
+  - files:
+      - "**/*.tsx"
+      - "**/*.ts"
+    customSyntax: postcss-styled-syntax

load_testing/README.md

@@ -1,14 +1,15 @@
-## Load Testing
+## k6 load testing
 
-#### Locust
+### Usage (Docker)
 
-The load testing system uses [Locust](https://docs.locust.io/en/stable/index.html) to run the load tests against the APIs. The entrypoint for this is `locustfile.py`. Locust automatically picks up the testing configuration based on subclassing things, you can read the docs for further details.
+```shell
+./scripts/k6.sh -e BACKEND_BASE_URL=#### -e FRONTEND_BASE_URL=####
+```
 
-#### Running
+### Usage (local k6)
 
-- Add `load-testing` to your `COMPOSE_PROFILES` setting.
-- Run `docker compose up` or `docker compose up locust locust-worker` (a more minimal set of services)
-- Go to http://localhost:8089/ and you should see the web UI for Locust.
-- Set the options you want to test (100 users is reasonable for local tests) and click Start
-- If you're testing against a backend that isn't reachable through the `nginx` hostname, you'll need to specify the alternative hostname.
-  - You can use this to test against deployed environments.
+- Install [k6](https://grafana.com/docs/k6/latest/set-up/install-k6/)
+
+```shell
+k6 run learn.ts -e BACKEND_BASE_URL=#### -e FRONTEND_BASE_URL=####
+```

load_testing/__init__.py

@@ -0,0 +1,13 @@
+import { SharedArray } from "k6/data"
+
+export function getAccessToken(): String {
+  return __ENV.AUTH_ACCESS_TOKEN
+}
+
+export const users = new SharedArray("users", function () {
+  if (!__ENV.USERS_JSON_FILE) {
+    return []
+  }
+
+  return JSON.parse(open(__ENV.USERS_JSON_FILE))
+})

load_testing/auth.ts

@@ -0,0 +1,28 @@
+import { Params } from "k6/http"
+import { BACKEND_BASE_URL } from "../../config.ts"
+import { MITLearnAPIClient as V0Client } from "./v0/api.ts"
+import { MITLearnAPIClient as V1Client } from "./v1/api.ts"
+import { getAccessToken } from "../../auth.ts"
+
+function getCommonRequestParameters(): Params {
+  const accessToken = getAccessToken()
+
+  return {
+    headers: {
+      ...(!!accessToken ? { Authorization: `Bearer ${accessToken}` } : {}),
+    },
+  }
+}
+
+export function createV0Client(): V0Client {
+  return new V0Client({
+    baseUrl: BACKEND_BASE_URL,
+    commonRequestParameters: getCommonRequestParameters(),
+  })
+}
+export function createV1Client(): V1Client {
+  return new V1Client({
+    baseUrl: BACKEND_BASE_URL,
+    commonRequestParameters: getCommonRequestParameters(),
+  })
+}