Add load test scripts (frain-dev#997)

* chore: add load test scripts

* fix: update load test script for outgoing events (frain-dev#1000)

* add workflow for running load tests in CI (frain-dev#1025)

* update loadtest script

* feat: add workflow for load test

* feat: add schedule for workflow

* fix: update secrets name

* chore: add trigger for workflow

* fix: update flag name

* fix: update file path

* chore: remove pull request trigger for workflow

Co-authored-by: Dotun Jolaoso <dotunjolaosho@gmail.com>

Author: jirevwe

.github/workflows/load-test.yml

@@ -0,0 +1,33 @@
+name: Run Load Test
+
+on:
+  schedule:
+    - cron: '30 14 * * *'
+    - cron: '30 18 * * *'
+    - cron: '30 21 * * *'
+
+  workflow_dispatch:
+    inputs:
+      name:
+        description: "Manual workflow name"
+        required: true
+
+
+jobs:
+   load_test: 
+     name: K6 Load Test
+     runs-on: ubuntu-latest
+
+     steps:
+      - name: Checkout
+        uses: actions/checkout@v1
+
+      - name: Run Local K6 Test
+        uses: grafana/k6-action@v0.2.0
+        with:
+         filename: loadtest/convoy.js 
+         flags: --out influxdb=${{ secrets.INFLUXDB_BASE_URL }}
+        env: 
+           BASE_URL: ${{ secrets.CONVOY_BASE_URL }}
+           API_KEY: ${{ secrets.CONVOY_API_KEY }}
+           APP_ID: ${{ secrets.CONVOY_APP_ID }}

loadtest/convoy.js

@@ -0,0 +1,89 @@
+import http from "k6/http";
+import { check, sleep } from "k6";
+import { Trend, Rate } from "k6/metrics";
+import { randomItem } from "https://jslib.k6.io/k6-utils/1.2.0/index.js";
+
+const baseUrl = `${__ENV.BASE_URL}/api/v1`;
+const apiKey = __ENV.API_KEY;
+const appId = __ENV.APP_ID;
+const params = {
+    headers: {
+        "Content-Type": "application/json",
+        Authorization: `Bearer ${apiKey}`,
+    },
+};
+
+const listEventsErrorRate = new Rate("List_Events_errors");
+const createEventErrorRate = new Rate("Create_Event_error");
+const ListEventsTrend = new Trend("List_Events");
+const createEventsTrend = new Trend("Create_Events");
+
+const names = ["John", "Jane", "Bert", "Ed"];
+const emails = [
+    "John@gmail.com",
+    "Jane@amazon.com",
+    "Bert@yahoo.com",
+    "Ed@hotmail.com",
+];
+
+export const generateEventPayload = (appId) => ({
+    app_id: appId,
+    data: {
+        player_name: randomItem(names),
+        email: randomItem(emails),
+    },
+    event_type: `${randomItem(names)}.${randomItem(names)}`.toLowerCase(),
+});
+
+export let options = {
+    noConnectionReuse: true,
+    stages: [
+        { duration: "60s", target: 20 }, // simulate ramp-up of traffic from 1 to 20 users over 60s
+        { duration: "60s", target: 20 }, // stay at 20 users for 60s
+    ],
+    thresholds: {
+        "List_Events": ["p(95) < 3000"], //95% of requests must complete below 3s
+        "Create_Events": ["p(99) < 3000"], //99% of requests must complete below 3s
+        "List_Events_errors": ["rate<0.1"], // error rate must be less than 10%
+        "Create_Event_error": ["rate<0.1"], // error rate must be less than 10%
+        http_req_duration: ["p(99)<6000"], // 99% of requests must complete below 6s
+    },
+};
+
+export default function () {
+    let eventBody = JSON.stringify(generateEventPayload(appId));
+    const listEventsUrl = `${baseUrl}/events?appId=${appId}`;
+    const createEventUrl = `${baseUrl}/events`;
+  
+    const requests = {
+        "List_Events": {
+            method: "GET",
+            url: listEventsUrl,
+            params: params,
+        },
+        "Create_Events": {
+            method: "POST",
+            url: createEventUrl,
+            params: params,
+            body: eventBody,
+        },
+    };
+
+    const responses = http.batch(requests)
+    const listResp = responses['List_Events'];
+    const createResp = responses['Create_Events'];
+
+    check(listResp, {
+      'list_events': (r) => r.status === 200,
+    }) || listEventsErrorRate.add(1);
+
+    ListEventsTrend.add(listResp.timings.duration)
+
+    check(createResp, {
+      'event_created': (r) => r.status === 201,
+    }) || createEventErrorRate.add(1)
+
+    createEventsTrend.add(createResp.timings.duration)
+    
+    sleep(1);
+}

loadtest/setup.sh

@@ -0,0 +1,60 @@
+#!/bin/bash
+
+# https://linuxtect.com/make-bash-shell-safe-with-set-euxo-pipefail/
+# https://gist.github.com/vncsna/64825d5609c146e80de8b1fd623011ca
+set -euo pipefail
+
+
+HOST=$1
+ENDPOINT=$2
+BASE_URL=$HOST/api/v1
+
+have_jq=$(which jq)
+
+# create the test group
+curl --location --request POST $BASE_URL/groups \
+--header 'Content-Type: application/json' \
+--data-raw '{
+    "config": {
+        "disableEndpoint": false,
+        "signature": {
+            "hash": "SHA256",
+            "header": "X-Test-Signature"
+        },
+        "strategy": {
+            "default": {
+                "intervalSeconds": 60,
+                "retryLimit": 10
+            },
+            "type": "default"
+        }
+    },
+    "rate_limit": 5000,
+    "rate_limit_duration": "1m",
+    "name": "load-test-group"
+}'
+
+# get groups
+groups=$(curl --location --request GET "$BASE_URL/groups")
+
+# get group for test
+groupId=$(echo $groups | jq --raw-output .data[0].uid)
+
+curl --location --request POST "$BASE_URL/applications?groupId=$groupId" \
+--header 'Content-Type: application/json' \
+--data-raw '{
+    "name": "staging",
+    "support_email": "getconvoy@gmail.com"
+}'
+
+# get apps
+apps=$(curl --location --request GET "$BASE_URL/applications?groupId=$groupId")
+
+# get group for test
+appId=$(echo $apps | jq --raw-output .data.content[-1:][0].uid)
+
+curl --location --request POST "$BASE_URL/applications/$appId/endpoints?groupId=$groupId" \
+--header 'Content-Type: application/json' \
+--data-raw "{ \"url\": \"$ENDPOINT\", \"description\": \"John wants to wick\", \"secret\": \"john-wicks-dog\" }"
+
+echo "group id: $groupId, app id $appId"