Improve wss initalization #99 && Improve closing application in docker #100

Author: Karql

CHANGELOG.md

@@ -1,3 +1,14 @@
+## 5.12.0
+
+### Changes
+* Improve wss initalization #99
+* Improve closing application in docker #100
+* Update npm packages
+
+### Breaking changes
+
+* Change logs format from short to structured #100
+
 ## 5.11.0
 
 ### Changes

Dockerfile

@@ -66,8 +66,6 @@ WORKDIR /opt/elastalert-server
 COPY package*.json ./
 RUN npm ci --omit=dev
 
-COPY scripts scripts
-
 COPY config/elastalert.yaml /opt/elastalert/config.yaml
 COPY config/elastalert-test.yaml /opt/elastalert/config-test.yaml
 COPY config/config.json config/config.json
@@ -82,4 +80,4 @@ RUN mkdir -p /opt/elastalert/rules/ /opt/elastalert/server_data/tests/ \
 USER node
 
 EXPOSE 3030
-ENTRYPOINT ["npm", "start"]
+CMD ["node", "dist/index.js"]

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "elastalert2-server",
-  "version": "5.11.0",
+  "version": "5.12.0",
   "description": "A server that runs ElastAlert2 and exposes REST API's for manipulating rules and alerts.",
   "license": "MIT",
   "main": "index.js",
@@ -45,7 +45,7 @@
   "scripts": {
     "dev": "concurrently \"nodemon\" \"nodemon --config nodemon-spec.json\"",
     "build": "tsoa spec-and-routes && tsc",
-    "start": "sh ./scripts/start.sh",
+    "start": "node dist/index.js",
     "serve": "nodemon --inspect --watch dist/ -d 1 ./dist/index.js",
     "tsc:watch": "tsc -w",
     "tsc:build": "tsc"

package.json

@@ -4,10 +4,8 @@ interface ExtWebSocket extends WebSocket {
   isAlive: boolean;
 }
 
-export let wss: WebSocket.Server;
-
 export function listen(port: number): WebSocket.Server {
-  wss = new WebSocket.Server({ port, path: '/test' });
+  let wss = new WebSocket.Server({ port, path: '/test' });
 
   wss.on('connection', (ws: ExtWebSocket) => {
     ws.isAlive = true;
@@ -16,19 +14,19 @@ export function listen(port: number): WebSocket.Server {
     });
   });
 
-  return wss;
-}
+  // Keepalive in case clients lose connection during a long rule test.
+  // If client doesn't respond in 10s this will close the socket and 
+  // therefore stop the elastalert test from continuing to run detached.
+  setInterval(() => {
+    wss.clients.forEach(ws => {
+      let extWs = <ExtWebSocket>ws;
 
-// Keepalive in case clients lose connection during a long rule test.
-// If client doesn't respond in 10s this will close the socket and 
-// therefore stop the elastalert test from continuing to run detached.
-setInterval(() => {
-  wss.clients.forEach(ws => {
-    let extWs = <ExtWebSocket>ws;
+      if (extWs.isAlive === false) {return ws.terminate();
+      }
+      extWs.isAlive = false;
+      extWs.ping(() => {});
+    });
+  }, 10000);
 
-    if (extWs.isAlive === false) {return ws.terminate();
-    }
-    extWs.isAlive = false;
-    extWs.ping(() => {});
-  });
-}, 10000);
+  return wss;
+}

scripts/start.sh

@@ -1,6 +1,7 @@
 import express, { Express,   Response as ExResponse,
   Request as ExRequest,
   NextFunction,} from 'express';
+import WebSocket from 'ws';
 import bodyParser from 'body-parser';
 import Logger from './common/logger';
 import config from './common/config';
@@ -22,6 +23,7 @@ let logger = new Logger('Server');
 
 export default class ElastalertServer {
   private _express: Express;
+  private _wss?: WebSocket.Server;
   private _runningTimeouts: NodeJS.Timeout[];
 
   private _processService: ProcessService;
@@ -48,6 +50,12 @@ export default class ElastalertServer {
 
     // Set listener on process exit (SIGINT == ^C)
     process.on('SIGINT', () => {
+      logger.info('Received signal: SIGINT');
+      process.exit(0);
+    });
+
+    process.on('SIGTERM', () => {
+      logger.info('Received signal: SIGTERM');
       process.exit(0);
     });
 
@@ -147,9 +155,9 @@ export default class ElastalertServer {
 
       logger.info('Server listening on port ' + config.get().port);
 
-      let wss = listen(config.get().wsport);
+      self._wss = listen(config.get().wsport);
 
-      wss.on('connection', (ws) => {
+      self._wss.on('connection', (ws) => {
         ws.on('message', (message) => {
           try {
             let data = JSON.parse(message.toString());
@@ -176,6 +184,7 @@ export default class ElastalertServer {
   stop() {
     this._processService?.stop();
     this._runningServer?.close();
+    this._wss?.close();
 
     this._runningTimeouts.forEach((timeout) => clearTimeout(timeout));
   }