chore: run stress test on selfhost runner

AppFlowy-IO · Dec 8, 2024 · 6d3ff3f · 6d3ff3f
1 parent b2f8a95
commit 6d3ff3f
Show file tree

Hide file tree

Showing 7 changed files with 264 additions and 32 deletions.
diff --git a/.github/workflows/stress_test.yml b/.github/workflows/stress_test.yml
@@ -0,0 +1,48 @@
+name: AppFlowy-Cloud Stress Test
+
+on: [ pull_request, push ]
+
+concurrency:
+  group: stress-test-${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
+  cancel-in-progress: false
+
+env:
+  POSTGRES_HOST: localhost
+  REDIS_HOST: localhost
+  MINIO_HOST: localhost
+  GOTRUE_HOST: localhost
+  SQLX_OFFLINE: true
+  RUST_TOOLCHAIN: "1.78"
+
+jobs:
+  test:
+    name: Collab Stress Tests
+    runs-on: self-hosted-appflowy3
+
+    steps:
+      - name: Checkout Repository
+        uses: actions/checkout@v3
+
+      - name: Install Rust Toolchain
+        uses: dtolnay/rust-toolchain@stable
+
+      - name: Copy and Rename deploy.env to .env
+        run: cp deploy.env .env
+
+      - name: Replace Values in .env
+        run: |
+          sed -i '' 's|RUST_LOG=.*|RUST_LOG=debug|' .env
+        shell: bash
+
+      - name: Start Docker Compose Services
+        run: |
+          docker compose -f docker-compose-stress-test.yml up -d 
+          docker ps -a
+
+      - name: Install Prerequisites
+        run: |
+          brew install protobuf
+
+      - name: Run Server and Test
+        run: |
+          cargo run --package xtask -- --stress-test
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/deploy.env b/deploy.env
@@ -4,7 +4,7 @@
 # PostgreSQL Settings
 POSTGRES_HOST=postgres
 POSTGRES_USER=postgres
-POSTGRES_PASSWORD=changepassword
+POSTGRES_PASSWORD=password
 POSTGRES_PORT=5432
 POSTGRES_DB=postgres
 
@@ -15,9 +15,18 @@ SUPABASE_PASSWORD=root
 REDIS_HOST=redis
 REDIS_PORT=6379
 
+# Minio Host
+MINIO_HOST=minio
+MINIO_PORT=9000
+
+# Gotrue Host
+GOTRUE_HOST=gotrue
+GOTRUE_PORT=9999
+GOTRUE_DATABASE_HOST=postgres
+
 # AppFlowy Cloud
 ## URL that connects to the gotrue docker container
-APPFLOWY_GOTRUE_BASE_URL=http://gotrue:9999
+APPFLOWY_GOTRUE_BASE_URL=http://${GOTRUE_HOST}:${GOTRUE_PORT}
 ## URL that connects to the postgres docker container
 APPFLOWY_DATABASE_URL=postgres://${POSTGRES_USER}:${POSTGRES_PASSWORD}@${POSTGRES_HOST}:${POSTGRES_PORT}/${POSTGRES_DB}
 APPFLOWY_ACCESS_CONTROL=true
@@ -30,7 +39,7 @@ APPFLOWY_REDIS_URI=redis://${REDIS_HOST}:${REDIS_PORT}
 ## URL that connects to redis docker container
 ADMIN_FRONTEND_REDIS_URL=redis://${REDIS_HOST}:${REDIS_PORT}
 ## URL that connects to gotrue docker container
-ADMIN_FRONTEND_GOTRUE_URL=http://gotrue:9999
+ADMIN_FRONTEND_GOTRUE_URL=http://${GOTRUE_HOST}:${GOTRUE_PORT}
 
 # authentication key, change this and keep the key safe and secret
 # self defined key, you can use any string
@@ -66,11 +75,12 @@ GOTRUE_ADMIN_PASSWORD=password
 # If you are using a different domain, you need to change the redirect_uri in the OAuth2 configuration
 # Make sure that this domain is accessible to the user
 # Make sure no endswith /
-API_EXTERNAL_URL=http://your-host
+# Replace with your host name instead of localhost
+API_EXTERNAL_URL=http://localhost:${GOTRUE_PORT}
 
 # In docker environment, `postgres` is the hostname of the postgres service
 # GoTrue connect to postgres using this url
-GOTRUE_DATABASE_URL=postgres://supabase_auth_admin:${SUPABASE_PASSWORD}@${POSTGRES_HOST}:${POSTGRES_PORT}/${POSTGRES_DB}
+GOTRUE_DATABASE_URL=postgres://supabase_auth_admin:${SUPABASE_PASSWORD}@${GOTRUE_DATABASE_HOST}:${POSTGRES_PORT}/${POSTGRES_DB}
 
 # Refer to this for details: https://github.com/AppFlowy-IO/AppFlowy-Cloud/blob/main/doc/AUTHENTICATION.md
 # Google OAuth2
@@ -102,7 +112,7 @@ APPFLOWY_S3_CREATE_BUCKET=true
 # By default, Minio is used as the default file storage which uses host's file system.
 # Keep this as true if you are using other S3 compatible storage provider other than AWS.
 APPFLOWY_S3_USE_MINIO=true
-APPFLOWY_S3_MINIO_URL=http://minio:9000 # change this if you are using a different address for minio
+APPFLOWY_S3_MINIO_URL=http://${MINIO_HOST}:${MINIO_PORT} # change this if you are using a different address for minio
 APPFLOWY_S3_ACCESS_KEY=minioadmin
 APPFLOWY_S3_SECRET_KEY=minioadmin
 APPFLOWY_S3_BUCKET=appflowy

diff --git a/docker-compose-stress-test.yml b/docker-compose-stress-test.yml
@@ -0,0 +1,97 @@
+services:
+  nginx:
+    restart: on-failure
+    image: nginx
+    ports:
+      - 80:80   # Disable this if you are using TLS
+      - 443:443
+    volumes:
+      - ./nginx/nginx.conf:/etc/nginx/nginx.conf
+      - ./nginx/ssl/certificate.crt:/etc/nginx/ssl/certificate.crt
+      - ./nginx/ssl/private_key.key:/etc/nginx/ssl/private_key.key
+  minio:
+    restart: on-failure
+    image: minio/minio
+    ports:
+      - 9000:9000
+      - 9001:9001
+    environment:
+      - MINIO_BROWSER_REDIRECT_URL=http://localhost:9001
+    command: server /data --console-address ":9001"
+
+  postgres:
+    restart: on-failure
+    image: pgvector/pgvector:pg16
+    environment:
+      - POSTGRES_USER=${POSTGRES_USER:-postgres}
+      - POSTGRES_DB=${POSTGRES_DB:-postgres}
+      - POSTGRES_PASSWORD=${POSTGRES_PASSWORD:-password}
+      - POSTGRES_HOST=${POSTGRES_HOST:-postgres}
+      - SUPABASE_USER=${SUPABASE_USER:-supabase_auth_admin}
+      - SUPABASE_PASSWORD=${SUPABASE_PASSWORD:-root}
+    ports:
+      - 5432:5432
+    volumes:
+      - ./migrations/before:/docker-entrypoint-initdb.d
+      # comment out the following line if you want to persist data when restarting docker
+      #- postgres_data:/var/lib/postgresql/data
+
+  redis:
+    restart: on-failure
+    image: redis
+    ports:
+      - 6379:6379
+
+  gotrue:
+    restart: on-failure
+    image: supabase/gotrue:v2.159.1
+    depends_on:
+      - postgres
+    environment:
+      # Gotrue config: https://github.com/supabase/gotrue/blob/master/example.env
+      - GOTRUE_SITE_URL=appflowy-flutter://                           # redirected to AppFlowy application
+      - URI_ALLOW_LIST=*                                              # adjust restrict if necessary
+      - GOTRUE_JWT_SECRET=${GOTRUE_JWT_SECRET}                        # authentication secret
+      - GOTRUE_JWT_EXP=${GOTRUE_JWT_EXP}
+      - GOTRUE_DB_DRIVER=postgres
+      - API_EXTERNAL_URL=${API_EXTERNAL_URL}
+      - DATABASE_URL=${GOTRUE_DATABASE_URL}
+      - PORT=9999
+      - GOTRUE_MAILER_URLPATHS_CONFIRMATION=/verify
+      - GOTRUE_SMTP_HOST=${GOTRUE_SMTP_HOST}                              # e.g. smtp.gmail.com
+      - GOTRUE_SMTP_PORT=${GOTRUE_SMTP_PORT}                              # e.g. 465
+      - GOTRUE_SMTP_USER=${GOTRUE_SMTP_USER}                              # email sender, e.g. noreply@appflowy.io
+      - GOTRUE_SMTP_PASS=${GOTRUE_SMTP_PASS}                              # email password
+      - GOTRUE_SMTP_ADMIN_EMAIL=${GOTRUE_SMTP_ADMIN_EMAIL}                # email with admin privileges e.g. internal@appflowy.io
+      - GOTRUE_SMTP_MAX_FREQUENCY=${GOTRUE_SMTP_MAX_FREQUENCY:-1ns}       # set to 1ns for running tests
+      - GOTRUE_RATE_LIMIT_EMAIL_SENT=${GOTRUE_RATE_LIMIT_EMAIL_SENT:-100} # number of email sendable per minute
+      - GOTRUE_MAILER_AUTOCONFIRM=${GOTRUE_MAILER_AUTOCONFIRM:-false}     # change this to true to skip email confirmation
+      # Google OAuth config
+      - GOTRUE_EXTERNAL_GOOGLE_ENABLED=${GOTRUE_EXTERNAL_GOOGLE_ENABLED}
+      - GOTRUE_EXTERNAL_GOOGLE_CLIENT_ID=${GOTRUE_EXTERNAL_GOOGLE_CLIENT_ID}
+      - GOTRUE_EXTERNAL_GOOGLE_SECRET=${GOTRUE_EXTERNAL_GOOGLE_SECRET}
+      - GOTRUE_EXTERNAL_GOOGLE_REDIRECT_URI=${GOTRUE_EXTERNAL_GOOGLE_REDIRECT_URI}
+      # Apple OAuth config
+      - GOTRUE_EXTERNAL_APPLE_ENABLED=${GOTRUE_EXTERNAL_APPLE_ENABLED}
+      - GOTRUE_EXTERNAL_APPLE_CLIENT_ID=${GOTRUE_EXTERNAL_APPLE_CLIENT_ID}
+      - GOTRUE_EXTERNAL_APPLE_SECRET=${GOTRUE_EXTERNAL_APPLE_SECRET}
+      - GOTRUE_EXTERNAL_APPLE_REDIRECT_URI=${GOTRUE_EXTERNAL_APPLE_REDIRECT_URI}
+      # GITHUB OAuth config
+      - GOTRUE_EXTERNAL_GITHUB_ENABLED=${GOTRUE_EXTERNAL_GITHUB_ENABLED}
+      - GOTRUE_EXTERNAL_GITHUB_CLIENT_ID=${GOTRUE_EXTERNAL_GITHUB_CLIENT_ID}
+      - GOTRUE_EXTERNAL_GITHUB_SECRET=${GOTRUE_EXTERNAL_GITHUB_SECRET}
+      - GOTRUE_EXTERNAL_GITHUB_REDIRECT_URI=${GOTRUE_EXTERNAL_GITHUB_REDIRECT_URI}
+      # Discord OAuth config
+      - GOTRUE_EXTERNAL_DISCORD_ENABLED=${GOTRUE_EXTERNAL_DISCORD_ENABLED}
+      - GOTRUE_EXTERNAL_DISCORD_CLIENT_ID=${GOTRUE_EXTERNAL_DISCORD_CLIENT_ID}
+      - GOTRUE_EXTERNAL_DISCORD_SECRET=${GOTRUE_EXTERNAL_DISCORD_SECRET}
+      - GOTRUE_EXTERNAL_DISCORD_REDIRECT_URI=${GOTRUE_EXTERNAL_DISCORD_REDIRECT_URI}
+      # Prometheus Metrics
+      - GOTRUE_METRICS_ENABLED=true
+      - GOTRUE_METRICS_EXPORTER=prometheus
+      - GOTRUE_MAILER_TEMPLATES_CONFIRMATION=${GOTRUE_MAILER_TEMPLATES_CONFIRMATION}
+    ports:
+      - 9999:9999
+
+volumes:
+  postgres_data:
diff --git a/tests/collab/stress_test.rs b/tests/collab/stress_test.rs
@@ -11,7 +11,7 @@ use client_api_test::{assert_server_collab, TestClient};
 use database_entity::dto::AFRole;
 
 #[tokio::test(flavor = "multi_thread", worker_threads = 4)]
-async fn run_multiple_text_edits() {
+async fn stress_test_run_multiple_text_edits() {
   const READER_COUNT: usize = 1;
   let test_scenario = Arc::new(TestScenario::open(
     "./tests/collab/asset/automerge-paper.json.gz",

diff --git a/xtask/Cargo.toml b/xtask/Cargo.toml
@@ -7,4 +7,5 @@ edition = "2021"
 
 [dependencies]
 anyhow = "1.0"
-tokio = { version = "1", features = ["full"] }
+tokio = { version = "1", features = ["full"] }
+futures = "0.3.31"