Merge branch 'chore/scale-test' into 'dev'

chore: add scale test package

See merge request ergo/rosen-bridge/rosenet!23

.changeset/shy-emus-argue.md

@@ -0,0 +1,2 @@
+---
+---

.changeset/strong-ears-drop.md

@@ -0,0 +1,5 @@
+---
+'@rosen-bridge/rosenet-node': patch
+---
+
+check cached stream writeStatus instead of status

.changeset/tough-phones-knock.md

@@ -0,0 +1,5 @@
+---
+'@rosen-bridge/rosenet-relay': minor
+---
+
+prevent applying default reservation limits

.changeset/twelve-rockets-sell.md

@@ -0,0 +1,5 @@
+---
+'@rosen-bridge/rosenet-node': patch
+---
+
+return cached streams with writeStatus of writing, too

.changeset/unlucky-rocks-impress.md

@@ -0,0 +1,5 @@
+---
+'@rosen-bridge/rosenet-node': patch
+---
+
+only choose outbound streams for sending messages

.github/workflows/scale-test-docker-release.yml

@@ -0,0 +1,44 @@
+name: Build and Push Scale Test Docker Image
+on:
+  push:
+    paths:
+      - 'packages/**'
+      - 'tests/scaling/**'
+
+jobs:
+  build:
+    strategy:
+      matrix:
+        role: [node, relay]
+
+    name: Build and Push Scale Test Docker Image
+    permissions: write-all
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout the Code
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+
+      - name: Login to Docker Registry
+        uses: docker/login-action@v2
+        with:
+          registry: ghcr.io
+          username: rosen-bridge
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Docker Metadata action
+        uses: docker/metadata-action@v5
+        id: meta
+        with:
+          images: ghcr.io/rosen-bridge/scale-test-${{matrix.role}}
+          tags: latest
+
+      - name: Build and push ${{matrix.role}}
+        uses: docker/build-push-action@v4
+        with:
+          context: .
+          file: 'tests/scaling/src/${{matrix.role}}/Dockerfile'
+          push: true
+          tags: ${{ steps.meta.outputs.tags }}

packages/rosenet-node/lib/getStreamAndPushable.ts

@@ -16,6 +16,13 @@ const cache = new Map<
   }
 >();
 
+/**
+ * return if a stream can be written on
+ * @param stream
+ */
+const isStreamWritable = (stream: Stream) =>
+  ['ready', 'writing'].includes(stream.writeStatus);
+
 /**
  * get a stream and a pushable to the `to` remotePeer with
  * ROSENET_DIRECT_PROTOCOL_V1 protocol, caching the pair for future use
@@ -25,7 +32,7 @@ const cache = new Map<
  */
 async function getStreamAndPushable(to: string, node: Libp2p) {
   const cacheHit = cache.get(to);
-  if (cacheHit?.stream.status === 'open') {
+  if (cacheHit && isStreamWritable(cacheHit.stream)) {
     RoseNetNodeTools.logger.debug(
       `Found existing stream and pushable in the cache to peer ${to}`,
       {
@@ -63,7 +70,8 @@ async function getStreamAndPushable(to: string, node: Libp2p) {
   const connectionStream = shuffle(connection.streams);
   const possibleWritableStream = connectionStream.find(
     (stream) =>
-      stream.writeStatus === 'ready' &&
+      isStreamWritable(stream) &&
+      stream.direction === 'outbound' &&
       stream.protocol === ROSENET_DIRECT_PROTOCOL_V1,
   );
   const stream =

packages/rosenet-relay/lib/createRoseNetRelay.ts

@@ -64,7 +64,14 @@ const createRoseNetRelay = async ({
     },
     streamMuxers: [mplex()],
     services: {
-      circuitRelay: circuitRelayServer(),
+      circuitRelay: circuitRelayServer({
+        reservations: {
+          maxReservations: config.maxReservations,
+          defaultDurationLimit: 0,
+          defaultDataLimit: 0n,
+          applyDefaultLimit: false,
+        },
+      }),
       pubsub: gossipsub({ allowPublishToZeroPeers: true }),
       identify: identify(),
     },

packages/rosenet-relay/lib/types.ts

@@ -8,4 +8,5 @@ export interface RoseNetRelayConfig {
   privateKey: string;
   logger: AbstractLogger;
   whitelist: string[];
+  maxReservations?: number;
 }

tests/scaling/.eslintignore

@@ -0,0 +1 @@
+dist

tests/scaling/README.md

@@ -0,0 +1,23 @@
+# RoseNet scaling test
+
+## Table of contents
+
+- [Introduction](#introduction)
+- [Usage](#usage)
+
+## Introduction
+
+RoseNet scaling test
+
+## Usage
+
+You need to have [OpenTofu](https://opentofu.org/) installed. Then, after
+[passing required variables](https://opentofu.org/docs/language/values/variables/#assigning-values-to-root-module-variables) (defined in [`variables.tf`](./variables.tf)),
+run the following commands. It should complete with no errors.
+
+```bash
+tofu init
+tofu apply
+```
+
+Finally run `tofu destroy` to destroy the infrastructure.