adding websocket support

Author: jkyberneees

README.md

@@ -38,20 +38,17 @@ GET /echo/10/ms 200 - - 10.244 ms
 ...
 ```
 
-# Implementation
-```js
-const restana = require('restana')
-const morgan = require('morgan')
-
-const service = restana()
-service.use(morgan('tiny'))
+# WebSocket support
+The service will accept WebSocket connections on port 3000, incoming messages will be echoed back to client. 
 
-service.get('/echo/:latency/ms', (req, res) => {
-  const { latency } = req.params
+## Example:
+(Chrome browser example)
+```js
+ws = new WebSocket('ws://localhost:3000/echo')
+ws.onmessage = (msg) => console.log(msg)
 
-  res.setHeader('x-added-latency-ms', latency)
-  setTimeout(() => res.send(req.headers), latency)
-})
+ws.send("Hello World")
 
-service.start(3000)
+// Incoming message printed in console:
+// MessageEvent {isTrusted: true, data: 'Hello World', origin: 'ws://localhost:3000', lastEventId: '', source: null, …}
 ```

index.js

@@ -1,7 +1,12 @@
 const restana = require('restana')
 const morgan = require('morgan')
+const http = require('http')
+const WebSocket = require('faye-websocket')
 
-const service = restana()
+const server = http.createServer()
+const service = restana({
+  server
+})
 service.use(morgan('tiny'))
 
 service.get('/echo/:latency/ms', (req, res) => {
@@ -11,4 +16,21 @@ service.get('/echo/:latency/ms', (req, res) => {
   setTimeout(() => res.send(req.headers), latency)
 })
 
+server.on('upgrade', function (request, socket, body) {
+  if (WebSocket.isWebSocket(request)) {
+    let ws = new WebSocket(request, socket, body)
+    console.log(`${new Date().toISOString()} - WebSocket connection started`)
+
+    ws.on('message', function (event) {
+      console.log(`${new Date().toISOString()} - Echoing WebSocket message...`)
+      ws.send(event.data)
+    })
+
+    ws.on('close', function (event) {
+      console.log(`${new Date().toISOString()} - WebSocket connection closed {code: "${event.code}", reason: "${event.reason}"}`)
+      ws = null
+    })
+  }
+})
+
 service.start(3000)

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "echo-api",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "description": "Basic Echo API to help debugging API gateway solutions and introduce artificial latency",
   "main": "index.js",
   "scripts": {
@@ -23,6 +23,7 @@
   },
   "homepage": "https://github.com/BackendStack21/echo-api#readme",
   "dependencies": {
+    "faye-websocket": "^0.11.4",
     "morgan": "^1.10.0",
     "restana": "^4.9.5"
   }