feat: Add k6 connection and message rate limiter tests by saniddhyaDubey · Pull Request #556 · cameri/nostream

saniddhyaDubey · 2026-04-21T03:32:03Z

Add k6 Load Testing Suite for Rate Limiters

Description

Adds k6 load tests to validate connection and message rate limiting behavior. (#469)

Tests Added:

connection-rate-limiter.ts - Tests 12 conn/sec limit across 4 load stages
message-rate-limiter.ts - Tests 3 msg/min limit with continuous REQ messages

Both tests require a running Docker instance and output formatted metrics showing success/rejection rates.

Motivation

Automate rate limiter testing. Previously manual (wscat only). Provides:

Repeatable load testing under controlled conditions
Quantified rejection rates vs configured limits
Foundation for future tests (event limits, subscriptions, etc.)

How to Test

docker-compose up -d
npm run test:connection
npm run test:message

Metrics output shows connection/message success rates and type breakdown.

Screenshots:

Message Rate Limiter Test:
Tests relay's ability to reject excess REQ messages at 3 msg/min limit. Shows 40 NOTICE rejections, 16 EOSE acceptances, and 72 EVENT results (62.50% success rate), with Redis message-specific rate limit keys stored alongside connection limits.

Connection Rate Limiter Test:
Tests relay's ability to reject excess connections at 12 conn/sec limit. Shows 350 successful connections vs 350 rate-limited rejections (50% rejection at 2x load), with Redis storing rate limit state visible in Docker sidebar.

Types of changes

New feature
Non-functional (foundation setup)

Checklist

Code follows project style
Tests added and passing
Docs added

…essage service rate limiting

socket-security · 2026-04-21T03:32:32Z

Review the following changes in direct dependencies. Learn more about Socket for GitHub.

Diff	Package	Supply Chain Security	Vulnerability	Quality	Maintenance	License
	@types/k6@1.7.0

View full report

coveralls · 2026-04-21T03:35:59Z

coverage: 74.533%. remained the same — saniddhyaDubey:perf/issue-469-k6-redis-testing into cameri:main

Copilot

Pull request overview

Adds a k6-based load testing suite intended to validate relay connection and message rate limiting behavior under concurrent WebSocket load.

Changes:

Added k6 WebSocket load test scripts for message and connection limiting.
Added npm scripts to run the new k6 tests (with a Docker container check).
Added @types/k6 and a changeset entry for the release.

Reviewed changes

Copilot reviewed 4 out of 5 changed files in this pull request and generated 6 comments.

Show a summary per file

File	Description
`test/integration/performance/message-limiting-k6.ts`	New k6 script to send REQ messages continuously and summarize NOTICE/EOSE/EVENT outcomes.
`test/integration/performance/connection-limiting-k6.ts`	New k6 script to create many WebSocket connections and summarize success vs. rate-limited outcomes.
`package.json`	Adds `test:connection` / `test:message` scripts and `@types/k6`.
`package-lock.json`	Locks `@types/k6` dependency.
`.changeset/jolly-canyons-glow.md`	Release note for adding the k6 tests.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-04-21T03:41:31Z

+"nostream": minor
+---
+
+perf: added k6 testing for redis on connection and message service rate limiting


Changeset text says this adds k6 testing "for redis". The added scripts exercise relay rate limiting over WebSocket; they don’t directly test Redis behavior, so the release note is misleading. Consider rewording to describe rate limiter load/performance tests without tying it to a specific storage backend.

Suggested change

perf: added k6 testing for redis on connection and message service rate limiting

perf: added k6 testing for connection and message service rate limiting

Copilot · 2026-04-21T03:41:32Z

+  const res = ws.connect(relayUrl, {}, function (socket) {
+    socket.on('close', () => {
+      socketClosed = true;
+      connectionRateLimited.add(1);
+    });
+
+    socket.on('open', () => {
+      connectionSuccess.add(1);
+    });
+
+    socket.setTimeout(() => {
+      if (!socketClosed) {
+        socket.close();
+      }
+    }, 3000);


connection_rate_limited is incremented on every socket close, including the intentional close triggered by setTimeout. This will misclassify successful connections as rate-limited and also misses true handshake rejections (e.g. HTTP 429), where the close/open handlers never run. Consider classifying rate-limited connections based on the ws.connect() response status (count non-101 responses) and only treating early/abnormal closes as rate limiting if you can reliably identify them (e.g. close code/reason).

Copilot · 2026-04-21T03:41:32Z

+};
+
+export default function () {
+  const res = ws.connect(relayUrl, null, function (socket) {


ws.connect(relayUrl, null, ...): k6's ws.connect expects a params object as the second argument. Passing null is unnecessary and can lead to runtime issues depending on how k6 handles the params value. Prefer {} (or omit the params arg if supported by your k6 version).

Suggested change

const res = ws.connect(relayUrl, null, function (socket) {

const res = ws.connect(relayUrl, {}, function (socket) {

Copilot · 2026-04-21T03:41:32Z

+      } catch (e: any) {
+        errorCounter.add(1);
+        console.error('Failed to parse message:', e.message);
+      }
+    });
+
+    socket.setTimeout(function () {
+      socket.close();
+    }, 9000);
+  });
+
+  check(res, { 
+    'status 101': (r) => r && r.status === 101,
+  });
+}
+
+export function handleSummary(data: any) {
+  const notices = data.metrics?.notice_messages?.values?.count || 0;
+  const eoses = data.metrics?.eose_messages?.values?.count || 0;
+  const events = data.metrics?.event_messages?.values?.count || 0;
+  const iterations = data.metrics?.iterations?.values?.count || 0;
+  const wsSessions = data.metrics?.ws_sessions?.values?.count || 0;
+  const msgsSent = data.metrics?.ws_msgs_sent?.values?.count || 0;
+  const msgsReceived = data.metrics?.ws_msgs_received?.values?.count || 0;
+  const dataReceived = data.metrics?.data_received?.values?.count || 0;
+  const checks = data.metrics?.checks?.values?.passes || 0;
+
+  const totalMessages = notices + eoses + events;
+  const successRate = totalMessages > 0 ? ((eoses + events) / totalMessages * 100).toFixed(2) : 0;
+
+  const rate = parseFloat(successRate as string);
+  const successStatus = rate >= 80 ? '✓ GOOD' : rate >= 50 ? '⚠ MODERATE' : '✗ POOR';
+  const rateLimitStatus = notices > 0 ? '⚠ ACTIVE' : '✓ INACTIVE';


This file contains TypeScript-only syntax (catch (e: any), data: any, successRate as string). k6 run executes JavaScript and will fail to parse TS annotations unless you add a transpilation step. Either remove TS-only syntax / use JSDoc types and rename to .js, or update the npm scripts to transpile before running k6.

cameri · 2026-04-21T03:43:47Z

@@ -0,0 +1,83 @@
+import { check, sleep } from 'k6';


let's move both files to test/performance

cameri · 2026-04-21T03:46:28Z

    "test:load": "node -r ts-node/register ./scripts/security-load-test.ts",
    "smoke:nip03": "node -r ts-node/register scripts/smoke-nip03.ts",
    "test:integration": "cucumber-js",
+    "test:connection": "docker ps | grep nostream > /dev/null && k6 run test/integration/performance/connection-limiting-k6.ts || echo 'Error: nostream container not running'",


Suggested change

"test:connection": "docker ps | grep nostream > /dev/null && k6 run test/integration/performance/connection-limiting-k6.ts || echo 'Error: nostream container not running'",

"test:performance:connection-rate-limit": "k6 run test/performance/connection-limiting-k6.ts",

cameri · 2026-04-21T03:47:03Z

    "smoke:nip03": "node -r ts-node/register scripts/smoke-nip03.ts",
    "test:integration": "cucumber-js",
+    "test:connection": "docker ps | grep nostream > /dev/null && k6 run test/integration/performance/connection-limiting-k6.ts || echo 'Error: nostream container not running'",
+    "test:message": "docker ps | grep nostream > /dev/null && k6 run test/integration/performance/message-limiting-k6.ts || echo 'Error: nostream container not running'",


Suggested change

"test:message": "docker ps | grep nostream > /dev/null && k6 run test/integration/performance/message-limiting-k6.ts || echo 'Error: nostream container not running'",

"test:performance:message-rate-limit": "k6 run test/performance/message-limiting-k6.ts",

cameri · 2026-04-21T03:48:07Z

    "@types/chai-as-promised": "^7.1.5",
    "@types/express": "4.17.21",
    "@types/js-yaml": "4.0.5",
+    "@types/k6": "^1.7.0",


do we not need k6 as well? or is it installed globally?

looks like we need to update the docs as well to document this. we can add it to CONTRIBUTING.md

saniddhyaDubey added 2 commits April 20, 2026 23:06

perf: k6 testing for rate limiting on connection and message service

8469e1d

docs(changeset): perf: added k6 testing for redis on connection and m…

01c4887

…essage service rate limiting

cameri requested a review from Copilot April 21, 2026 03:38

cameri self-assigned this Apr 21, 2026

Merge branch 'main' into perf/issue-469-k6-redis-testing

3dba290

Copilot started reviewing on behalf of cameri April 21, 2026 03:38 View session

Copilot AI reviewed Apr 21, 2026

View reviewed changes

cameri reviewed Apr 21, 2026

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Add k6 connection and message rate limiter tests#556

feat: Add k6 connection and message rate limiter tests#556
saniddhyaDubey wants to merge 3 commits intocameri:mainfrom
saniddhyaDubey:perf/issue-469-k6-redis-testing

saniddhyaDubey commented Apr 21, 2026

Uh oh!

socket-security Bot commented Apr 21, 2026 •

edited

Loading

Uh oh!

coveralls commented Apr 21, 2026 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Copilot AI Apr 21, 2026

Uh oh!

Copilot AI Apr 21, 2026

Uh oh!

Uh oh!

Copilot AI Apr 21, 2026

Uh oh!

Copilot AI Apr 21, 2026

Uh oh!

cameri Apr 21, 2026

Uh oh!

cameri Apr 21, 2026

Uh oh!

cameri Apr 21, 2026

Uh oh!

cameri Apr 21, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

	perf: added k6 testing for redis on connection and message service rate limiting
	perf: added k6 testing for connection and message service rate limiting

	const res = ws.connect(relayUrl, null, function (socket) {
	const res = ws.connect(relayUrl, {}, function (socket) {

	"test:connection": "docker ps \| grep nostream > /dev/null && k6 run test/integration/performance/connection-limiting-k6.ts \|\| echo 'Error: nostream container not running'",
	"test:performance:connection-rate-limit": "k6 run test/performance/connection-limiting-k6.ts",

	"test:message": "docker ps \| grep nostream > /dev/null && k6 run test/integration/performance/message-limiting-k6.ts \|\| echo 'Error: nostream container not running'",
	"test:performance:message-rate-limit": "k6 run test/performance/message-limiting-k6.ts",

Conversation

saniddhyaDubey commented Apr 21, 2026

Add k6 Load Testing Suite for Rate Limiters

Description

Motivation

How to Test

Screenshots:

Types of changes

Checklist

Uh oh!

socket-security Bot commented Apr 21, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

coveralls commented Apr 21, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Copilot AI Apr 21, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 21, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Copilot AI Apr 21, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 21, 2026

Choose a reason for hiding this comment

Uh oh!

cameri Apr 21, 2026

Choose a reason for hiding this comment

Uh oh!

cameri Apr 21, 2026

Choose a reason for hiding this comment

Uh oh!

cameri Apr 21, 2026

Choose a reason for hiding this comment

Uh oh!

cameri Apr 21, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

socket-security Bot commented Apr 21, 2026 •

edited

Loading

coveralls commented Apr 21, 2026 •

edited

Loading