Merge 54c20d4 into 9399f53

CHANGELOG.md

@@ -1,3 +1,9 @@
+## [4.2.2] - 2019.09.17
+
+### Fix
+
+Adding health-checks for all ws based endpoints.
+
 ## [4.2.1] - 2019.09.17
 
 ### Fix

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@deepstream/server",
-  "version": "4.2.1",
+  "version": "4.2.2",
   "description": "a scalable server for realtime webapps",
   "main": "./dist/src/deepstream.io.js",
   "bin": {

src/connection-endpoint/json/connection-endpoint.ts

@@ -3,7 +3,7 @@ import {createWSSocketWrapper} from './socket-wrapper-factory'
 import { DeepstreamServices, SocketWrapper, DeepstreamConfig, UnauthenticatedSocketWrapper } from '../../../ds-types/src/index'
 import { Dictionary } from 'ts-essentials'
 import * as WebSocket from 'ws'
-import { IncomingMessage } from 'http'
+import { IncomingMessage, Server } from 'http'
 
 /**
  * This is the frontmost class of deepstream's message pipeline. It receives
@@ -13,27 +13,34 @@ import { IncomingMessage } from 'http'
 export class WSJSONConnectionEndpoint extends ConnectionEndpoint {
   private server!: WebSocket.Server
   private connections = new Map<WebSocket, UnauthenticatedSocketWrapper>()
+  private httpServer: Server
 
   constructor (private wsOptions: WebSocketServerConfig, services: DeepstreamServices, config: DeepstreamConfig) {
     super(wsOptions, services, config)
     this.description = 'WS JSON Connection Endpoint (ONLY FOR SDK DEVELOPMENT)'
     this.onMessages = this.onMessages.bind(this)
+    this.httpServer = this.wsOptions.httpServer ? this.wsOptions.httpServer : new Server()
   }
 
   /**
    * Initialize the ws endpoint, setup callbacks etc.
    */
   public createWebsocketServer () {
+    this.server = new WebSocket.Server({
+      server: this.httpServer
+    })
     if (this.wsOptions.httpServer) {
-      this.server = new WebSocket.Server({
-        server: this.wsOptions.httpServer
-      })
       process.nextTick(this.onReady.bind(this))
     } else {
-      this.server = new WebSocket.Server({
-        port: this.getOption('port'),
-        host: this.getOption('host')
-      }, () => this.onReady())
+      this.httpServer.on('request', (request, response) => {
+        if (request.url === this.wsOptions.healthCheckPath && request.method === 'GET') {
+          response.end()
+        } else {
+          response.writeHead(404)
+          response.end(`Only ${this.wsOptions.healthCheckPath} supported`)
+        }
+      })
+      this.httpServer.listen(this.getOption('port'), this.getOption('host'), this.onReady.bind(this))
     }
 
     this.server.on('connection', (websocket, request) => {
@@ -73,7 +80,7 @@ export class WSJSONConnectionEndpoint extends ConnectionEndpoint {
     })
     await Promise.all(closePromises)
     this.connections.clear()
-    return new Promise((resolve) => this.server.close(resolve))
+    return new Promise((resolve) => this.httpServer.close(resolve))
   }
 
   /**

src/connection-endpoint/text/connection-endpoint.ts

@@ -22,6 +22,7 @@ export class WSTextConnectionEndpoint extends ConnectionEndpoint {
   private server!: WebSocket.Server
   private connections = new Map<WebSocket, UnauthenticatedSocketWrapper>()
   private pingMessage: string
+  private httpServer: Server
 
   constructor (private wsOptions: WSConnectionEndpointConfig, services: DeepstreamServices, config: DeepstreamConfig) {
     super(wsOptions, services, config)
@@ -31,22 +32,28 @@ export class WSTextConnectionEndpoint extends ConnectionEndpoint {
       topic: TOPIC.CONNECTION,
       action: CONNECTION_ACTION.PING
     })
+    this.httpServer = this.wsOptions.httpServer ? this.wsOptions.httpServer : new Server()
   }
 
   /**
    * Initialize the ws endpoint, setup callbacks etc.
    */
   public createWebsocketServer () {
+    this.server = new WebSocket.Server({
+      server: this.httpServer
+    })
     if (this.wsOptions.httpServer) {
-      this.server = new WebSocket.Server({
-        server: this.wsOptions.httpServer
-      })
       process.nextTick(this.onReady.bind(this))
     } else {
-      this.server = new WebSocket.Server({
-        port: this.getOption('port'),
-        host: this.getOption('host')
-      }, () => this.onReady())
+      this.httpServer.on('request', (request, response) => {
+        if (request.url === this.wsOptions.healthCheckPath && request.method === 'GET') {
+          response.end()
+        } else {
+          response.writeHead(404)
+          response.end(`Only ${this.wsOptions.healthCheckPath} supported`)
+        }
+      })
+      this.httpServer.listen(this.getOption('port'), this.getOption('host'), this.onReady.bind(this))
     }
 
     this.server.on('connection', (websocket, request) => {
@@ -104,7 +111,7 @@ export class WSTextConnectionEndpoint extends ConnectionEndpoint {
     })
     await Promise.all(closePromises)
     this.connections.clear()
-    return new Promise((resolve) => this.server.close(resolve))
+    return new Promise((resolve) => this.httpServer.close(resolve))
   }
 
   /**

src/connection-endpoint/websocket/connection-endpoint.ts

@@ -9,6 +9,7 @@ export interface WebSocketServerConfig {
   outgoingBufferTimeout: number,
   maxBufferByteSize: number,
   headers: string[],
+  healthCheckPath: string,
   [index: string]: any,
 }
 

src/connection-endpoint/ws/connection-endpoint.ts

@@ -18,27 +18,34 @@ interface WSConnectionEndpointConfig extends WebSocketServerConfig {
 export class WSConnectionEndpoint extends ConnectionEndpoint {
   private server!: WebSocket.Server
   private connections = new Map<WebSocket, UnauthenticatedSocketWrapper>()
+  private httpServer!: Server
 
   constructor (private wsOptions: WSConnectionEndpointConfig, services: DeepstreamServices, config: DeepstreamConfig) {
     super(wsOptions, services, config)
     this.description = 'WS Connection Endpoint'
     this.onMessages = this.onMessages.bind(this)
+    this.httpServer = this.wsOptions.httpServer ? this.wsOptions.httpServer : new Server()
   }
 
   /**
    * Initialize the ws endpoint, setup callbacks etc.
    */
   public createWebsocketServer () {
+    this.server = new WebSocket.Server({
+      server: this.httpServer
+    })
     if (this.wsOptions.httpServer) {
-      this.server = new WebSocket.Server({
-        server: this.wsOptions.httpServer
-      })
       process.nextTick(this.onReady.bind(this))
     } else {
-      this.server = new WebSocket.Server({
-        port: this.getOption('port'),
-        host: this.getOption('host')
-      }, () => this.onReady())
+      this.httpServer.on('request', (request, response) => {
+        if (request.url === this.wsOptions.healthCheckPath && request.method === 'GET') {
+          response.end()
+        } else {
+          response.writeHead(404)
+          response.end(`Only ${this.wsOptions.healthCheckPath} supported`)
+        }
+      })
+      this.httpServer.listen(this.getOption('port'), this.getOption('host'), this.onReady.bind(this))
     }
 
     this.server.on('connection', (websocket, request) => {
@@ -80,7 +87,7 @@ export class WSConnectionEndpoint extends ConnectionEndpoint {
     })
     await Promise.all(closePromises)
     this.connections.clear()
-    return new Promise((resolve) => this.server.close(resolve))
+    return new Promise((resolve) => this.httpServer.close(resolve))
   }
 
   /**