feat: add integration tests w/ docker

Author: cameri

.github/workflows/checks.yml

@@ -27,7 +27,6 @@ jobs:
     runs-on: ubuntu-latest
     container:
       image: node:18-alpine3.16
-    needs: [lint]
     steps:
       - uses: actions/checkout@v3
       - uses: actions/setup-node@v3
@@ -38,12 +37,11 @@ jobs:
         run: npm ci
       - name: Run ESLint
         run: npm run build
-  test:
-    name: Tests
+  test-and-cover:
+    name: Unit Tests
     runs-on: ubuntu-latest
     container:
       image: node:18-alpine3.16
-    needs: [build]
     steps:
       - uses: actions/checkout@v3
       - uses: actions/setup-node@v3
@@ -52,14 +50,21 @@ jobs:
           cache: npm
       - name: Install package dependencies
         run: npm ci
-      - name: Run tests
+      - name: Run unit tests
         run: npm run test:unit
-  coverage:
-    name: Coverage
+      - name: Run coverage for unit tests
+        run: npm run cover
+      - name: Coveralls
+        uses: coverallsapp/github-action@master
+        with:
+          path-to-lcov: ./.coverage/lcov.info
+          flag-name: Unit
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+  test-integration:
+    name: Integration Tests
     runs-on: ubuntu-latest
     container:
       image: node:18-alpine3.16
-    needs: [build]
     steps:
       - uses: actions/checkout@v3
       - uses: actions/setup-node@v3
@@ -68,11 +73,5 @@ jobs:
           cache: npm
       - name: Install package dependencies
         run: npm ci
-      - name: Run coverage
-        run: npm run cover
-      - name: Coveralls
-        uses: coverallsapp/github-action@master
-        with:
-          path-to-lcov: ./.coverage/lcov.info
-          flag-name: Unit
-          github-token: ${{ secrets.GITHUB_TOKEN }}
+      - name: Run integration tests
+        run: npm run docker:test:integration

cucumber.js

@@ -1,10 +1,10 @@
 const config = [
   'test/integration/features/**/*.feature',
   '--require-module ts-node/register',
-  '--require tests/integration/features/**/*.ts',
-  '--format progress-bar',
-  '--format json:report.json',
-  '--publish-quiet',
+  '--require test/integration/features/**/*.ts',
+  '--require test/integration/features/*.ts',
+  '--format @cucumber/pretty-formatter',
+  '--publish',
 ].join(' ')
 
 module.exports = {

docker-compose.yml

@@ -8,6 +8,8 @@ services:
       DB_USER: nostr_ts_relay
       DB_PASSWORD: nostr_ts_relay
       DB_NAME: nostr_ts_relay
+      DB_MIN_POOL_SIZE: 1
+      DB_MAX_POOL_SIZE: 2
       NOSTR_CONFIG_DIR: /home/node/
     user: node:node
     volumes:

knexfile.js

@@ -7,7 +7,6 @@ module.exports = {
     password: process.env.DB_PASSWORD ?? 'postgres',
     database: process.env.DB_NAME ?? 'nostr-ts-relay',
   },
-  pool: { min: 4, max: 16 },
   seeds: {
     directory: './seeds',
   },

package-lock.json

@@ -16,7 +16,7 @@
   ],
   "main": "src/index.ts",
   "scripts": {
-    "dev": "ts-node src/index.ts",
+    "dev": "node -r ts-node/register src/index.ts",
     "clean": "rimraf ./dist",
     "build": "tsc --project tsconfig.build.json",
     "prestart": "npm run build",
@@ -35,7 +35,8 @@
     "predocker:compose:up": "[ -d \"$HOME/.nostr\" ] || mkdir -p $HOME/.nostr",
     "docker:compose:up": "docker compose up --build",
     "docker:compose:down": "docker compose down",
-    "docker:compose:rm": "docker compose rm"
+    "docker:compose:rm": "docker compose rm",
+    "docker:test:integration": "docker compose -f ./test/integration/docker-compose.yml up tests --build --exit-code-from tests"
   },
   "repository": {
     "type": "git",
@@ -53,6 +54,7 @@
   "homepage": "https://github.com/Cameri/nostr-ts-relay#readme",
   "devDependencies": {
     "@cucumber/cucumber": "8.7.0",
+    "@cucumber/pretty-formatter": "1.0.0",
     "@types/chai": "^4.3.1",
     "@types/chai-as-promised": "^7.1.5",
     "@types/mocha": "^9.1.1",

package.json

@@ -1,3 +1,4 @@
+import cluster from 'cluster'
 import { EventEmitter } from 'stream'
 import { IncomingMessage as IncomingHttpMessage } from 'http'
 import { WebSocket } from 'ws'
@@ -60,10 +61,12 @@ export class WebSocketAdapter extends EventEmitter implements IWebSocketAdapter
 
   public onBroadcast(event: Event): void {
     this.webSocketServer.emit(WebSocketServerAdapterEvent.Broadcast, event)
-    process.send({
-      eventName: WebSocketServerAdapterEvent.Broadcast,
-      event,
-    })
+    if (cluster.isWorker) {
+      process.send({
+        eventName: WebSocketServerAdapterEvent.Broadcast,
+        event,
+      })
+    }
   }
 
   public onSendEvent(event: Event): void {

src/adapters/web-socket-adapter.ts

@@ -44,6 +44,7 @@ export class WebSocketServerAdapter extends WebServerAdapter implements IWebSock
   }
 
   public close(callback: () => void): void {
+    this.onClose()
     this.webSocketServer.close(() => {
       this.webServer.close(callback)
     })

src/adapters/web-socket-server-adapter.ts

@@ -6,7 +6,7 @@ export class AppWorker implements IRunnable {
     private readonly process: NodeJS.Process,
     private readonly adapter: IWebSocketServerAdapter
   ) {
-    process
+    this.process
       .on('message', this.onMessage.bind(this))
       .on('SIGINT', this.onExit.bind(this))
       .on('SIGHUP', this.onExit.bind(this))
@@ -34,11 +34,12 @@ export class AppWorker implements IRunnable {
 
   private onExit() {
     console.log(`worker ${process.pid} - exiting`)
-    this.adapter.close(() => {
-      // dbClient.destroy(() => {
-      //   process.exit(0)
-      // })
-      process.exit(0)
+    this.close(() => {
+      this.process.exit(0)
     })
   }
+
+  public close(callback?: () => void) {
+    this.adapter.close(callback)
+  }
 }

src/app/worker.ts

@@ -9,7 +9,7 @@ import { getDbClient } from '../database/client'
 import { webSocketAdapterFactory } from './websocket-adapter-factory'
 import { WebSocketServerAdapter } from '../adapters/web-socket-server-adapter'
 
-export const workerFactory = () => {
+export const workerFactory = (): AppWorker => {
   const dbClient = getDbClient()
   const eventRepository = new EventRepository(dbClient)