Unit Tests for Server App

.dockerignore

@@ -5,7 +5,8 @@ npm-debug.log
 # Environment files
 .env
 .env.local
-.env.*.local
+.env.prod
+config
 
 # Git
 .git
@@ -37,3 +38,6 @@ docker-compose*.yml
 dist
 build
 
+# ignore tests
+tests
+coverage

.github/workflows/push-images.yml

@@ -1,7 +1,9 @@
 name: Build and push images to GHCR
 
 on:
-  workflow_dispatch:
+  push:
+    branches:
+      - main
 
 permissions:
   contents: read
@@ -24,11 +26,11 @@ jobs:
       - name: Build & push server image
         run: |
           IMAGE=ghcr.io/rubinskiy/server:latest
-          docker build -t $IMAGE -f Dockerfile.server .
+          docker build -t $IMAGE -f server/Dockerfile.server .
           docker push $IMAGE
 
       - name: Build & push consumer image
         run: |
           IMAGE=ghcr.io/rubinskiy/consumer:latest
-          docker build -t $IMAGE -f Dockerfile.consumer .
+          docker build -t $IMAGE -f consumer/Dockerfile.consumer .
           docker push $IMAGE

.github/workflows/server-tests.yml

@@ -0,0 +1,66 @@
+name: Unit Tests for Server
+
+on:
+  pull_request:
+    branches:
+      - staging
+    paths:
+      - 'server/**'
+  push:
+    branches:
+      - staging
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v4
+
+    - name: Setup Node.js
+      uses: actions/setup-node@v4
+      with:
+        node-version: '20'
+        cache: 'npm'
+
+    - name: Install server dependencies
+      run: npm install --ignore-scripts
+      working-directory: server
+
+    - name: Run Unit Tests & Generate Coverage
+      run: npm run test:unit -- --coverage
+      working-directory: server
+      env:
+        NODE_ENV: test
+        REDIS_PWD: ${{ secrets.REDIS_PWD }}
+        REDIS_HOST: ${{ secrets.REDIS_HOST }}
+        REDIS_PORT: ${{ secrets.REDIS_PORT }}
+        SUPABASE_DB_URL: ${{ secrets.SUPABASE_DB_URL }}
+
+    - name: Upload coverage reports
+      uses: codecov/codecov-action@ab904c41d6ece82784817410c45d8b8c02684457
+      with:
+        directory: server/coverage
+        fail_ci_if_error: false
+
+  lint:
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v4
+
+    - name: Setup Node.js
+      uses: actions/setup-node@v4
+      with:
+        node-version: '20'
+        cache: 'npm'
+
+    - name: Install dependencies
+      run: npm install --ignore-scripts
+      working-directory: server
+
+    - name: Run ESLint
+      run: npx eslint server --ext .js
+      continue-on-error: true

.github/workflows/sonarqube.yml

@@ -0,0 +1,40 @@
+name: SonarQube Scan
+
+on:
+  workflow_run:
+    workflows: ["Unit Tests for Server"]
+    types:
+      - completed
+
+jobs:
+  scan:
+    runs-on: ubuntu-latest
+    environment: analysis
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+
+      - name: Install Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: 18
+
+      - name: Install dependencies
+        run: npm install --ignore-scripts
+
+      # Optional: run tests to generate coverage file
+      #- name: Run tests
+      #  run: npm test -- --coverage
+
+      - name: SonarQube Scan
+        uses: sonarsource/sonarqube-scan-action@v2
+        with:
+          projectBaseDir: server
+          args: >
+            -Dsonar.organization=${{ secrets.SONAR_ORGANIZATION }}
+            -Dsonar.projectKey=${{ secrets.SONAR_PROJECT_KEY }}
+            -Dsonar.javascript.lcov.reportPaths=coverage/lcov.info
+        env:
+          SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
+          SONAR_HOST_URL: https://sonarcloud.io

README.md

@@ -1,2 +1,58 @@
 # prototype-rtc-js
 Real -time scalable group chat app with uWebSockets, Redis, and Postgres
+
+### How to run (Local) >>
+
+Using code?
+```bash
+node server.js
+
+node consumer.js
+```
+Also run local redis instance.
+```bash
+docker start redis-local
+```
+Also run local Postgres instance.
+```bash
+docker start local-pg
+```
+Don't forget to change env variables to local redis and pg
+```bash
+SUPABASE_DB_URL=postgres://postgres:postgres@localhost:5432/messages
+```
+
+Using containers to run server?
+```bash
+docker build -t server-local -f Dockerfile.server .
+
+docker run --env-file .env-local -p 9001:9001 server-local
+```
+Run local redis instance too.
+
+### How to run (PM2 Multiple Instances) >>
+
+```bash
+pm2 start server.js -i <instance-num>
+```
+
+Also run local redis instance.
+Change local vars to local redis host and port.
+
+Check logs
+```bash
+pm2 logs
+```
+
+Stop all instances
+```bash
+pm2 stop all
+```
+
+### Testing >>
+
+Server Unit Tests
+```bash
+cd server
+npm run test:unit
+```

.env.example → config/.env.example

@@ -2,3 +2,8 @@ SUPABASE_DB_URL=
 REDIS_PWD=
 REDIS_HOST=
 REDIS_PORT=
+
+# TESTS
+TOTAL_MESSAGES=
+BATCH_SIZE=
+CONCURRENCY=

consumer/Dockerfile.consumer

@@ -0,0 +1,19 @@
+# Dockerfile.consumer
+FROM node:20-alpine
+
+WORKDIR /app
+
+# Install only production dependencies
+COPY package*.json ./
+RUN npm ci --only=production
+
+# Copy consumer modular codebase structure
+COPY consumer/ ./consumer/
+
+# Copy config directory (for .env file structure)
+# Note: .env file should be provided via environment variables in production
+# The config directory should exist in the repo (even if empty)
+COPY config/ ./config/
+
+# Small health-check-friendly default command
+CMD ["node", "consumer/consumer.js"]