EXPERIMENT: add a benchmarker

Author: NarrowsProjects

.github/workflows/bookkeeping.yml

@@ -15,6 +15,62 @@ concurrency:
   cancel-in-progress: true
 
 jobs:
+  benchmark:
+    name: envs benchmarks
+    runs-on: ubuntu-latest
+    timeout-minutes: 10
+
+    strategy:
+      fail-fast: false
+
+    steps:
+      - uses: actions/checkout@v6
+      - name: Set up Docker
+        uses: docker/setup-buildx-action@v4
+
+      - name: Create Coverage Directory
+        run: mkdir -p ${{ github.workspace }}/coverage
+
+      - name: Set COMPOSE_PROJECT_NAME
+        run: echo "COMPOSE_PROJECT_NAME=benchmark_app" >> $GITHUB_ENV
+
+      - name: Build and Start Test Database
+        run: |
+          docker compose \
+          -f docker-compose.test-parallel-base.yml \
+          -f docker-compose.test-parallel-ci.yml \
+          up --detach test_db
+        env:
+          TEST_TYPE: envs
+
+      - name: Build Test Container
+        run: |
+          docker compose \
+          -f docker-compose.test-parallel-base.yml \
+          -f docker-compose.test-parallel-ci.yml \
+          build test_app
+        env:
+          TEST_TYPE: envs
+
+      - name: Run Benchmarks
+        run: |
+          docker compose \
+          -f docker-compose.test-parallel-base.yml \
+          -f docker-compose.test-parallel-ci.yml \
+          run test_app npm run benchmark
+        env:
+          TEST_TYPE: envs
+
+      - name: Clean Up
+        if: always()
+        run: |
+          docker compose \
+          -f docker-compose.test-parallel-base.yml \
+          -f docker-compose.test-parallel-ci.yml \
+          down
+        env:
+          TEST_TYPE: envs
+    
   parallel_tests:
     name: ${{ matrix.test_type }}
     runs-on: ubuntu-latest

package.json

@@ -15,6 +15,7 @@
     "start:dev": "nodemon --ignore 'lib/public/**/*.js' lib/main.js",
     "start:prod": "node lib/main.js",
     "test": "mocha --exit --timeout 0",
+    "benchmark": "node ./opt/test.js",
     "test:subset": "nyc -- mocha --exit --timeout 0 test/scripts/test-${TEST_TYPE}.js && nyc report --report-dir=/usr/src/app/coverage/${TEST_TYPE} --reporter=json",
     "test:subset-local": "mocha --exit --timeout 0 --reporter test/scripts/parallel-local/custom-mocha-reporter.js test/scripts/test-${TEST_TYPE}.js",
     "docker-run": "docker compose -f docker-compose.yml -f docker-compose.dev.yml up --build",

scripts/test.js

@@ -0,0 +1,72 @@
+import http from 'http';
+
+
+const ITERATIONS = 100;
+const token = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6MCwidXNlcm5hbWUiOiJhbm9ueW1vdXMiLCJuYW1lIjoiQW5vbnltb3VzIiwiYWNjZXNzIjoiYWRtaW4iLCJpYXQiOjE3ODIzOTk4MjgsImV4cCI6MTc4MzAwNDYyOCwiaXNzIjoibzItdWkifQ.7WPQ0YSB60_XZUV62jtzMTmxV08Zd5eeVolsb56XFRA';
+
+
+function request(url) {
+ return new Promise((resolve) => {
+   const start = Date.now();
+
+
+   http.get(url, (res) => {
+       res.resume();
+       res.on("end", () => {
+           resolve({ responseTime: Date.now() - start, statusCode: res.statusCode });
+       });
+   })
+ });
+}
+
+
+const latencyData = {};
+
+
+async function runTest(key, endpoint) {
+ const results = [];
+
+
+ for (let i = 1; i <= ITERATIONS; i++) {
+   const result = await request(`${endpoint}&token=${token}`);
+   results.push(result);
+ }
+
+
+
+
+ const times = results.map((r) => r.responseTime);
+ const sorted = [...times].sort((a, b) => a - b);
+ const avg = times.reduce((a, b) => a + b, 0) / times.length;
+ const min = sorted[0];
+ const max = sorted[sorted.length - 1];
+
+
+ latencyData[key] = { endpoint, min, max, avg: avg.toFixed(2) };
+}
+
+
+
+
+function printResults() {
+   console.log("====== Latency Benchmark Results ======");
+
+
+   for (let [key, { endpoint, min, max, avg }] of Object.entries(latencyData)) {
+       console.log(`Page:       ${key}`);
+       console.log(`Endpoint:   GET ${endpoint}`);
+       console.log(`Iterations: ${ITERATIONS}`);
+       console.log(`Min:        ${min} ms`);
+       console.log(`Max:        ${max} ms`);
+       console.log(`Avg:        ${avg} ms`);
+       console.log("---------------------------------------");
+   }
+
+
+   console.log("=======================================");
+}
+
+
+Promise.all([
+   await runTest('Envs', 'http://localhost:4000/api/environments?page[offset]=0&page[limit]=10'),
+]).then(printResults);