refactor: simplify websocket code

server/package.json

@@ -13,9 +13,13 @@
   },
   "dependencies": {
     "portfinder": "^1.0.32",
+    "reconnecting-websocket": "^4.4.0",
     "vscode-languageserver": "^8.0.2",
     "vscode-languageserver-textdocument": "^1.0.8",
     "ws": "^8.17.1"
   },
+  "devDependencies": {
+    "@types/ws": "^8.5.10"
+  },
   "scripts": {}
 }

server/src/engine/socket.ts

@@ -19,13 +19,12 @@ import * as queue from './queue'
 import { clearDiagnostics, sendNotification } from '../server'
 import { EventEmitter } from 'events'
 import { handleCrash, lspCheckResponseHandler } from '../handlers'
-import { getPort } from 'portfinder'
 import { USER_MESSAGE } from '../util/userMessages'
 import { StatusCode } from '../util/statusCodes'
+import ReconnectingWebSocket from 'reconnecting-websocket'
+import WebSocket from 'ws'
 
-const WebSocket = require('ws')
-
-let webSocket: any
+let webSocket: ReconnectingWebSocket
 let webSocketOpen = false
 
 // event emitter to handle communication between socket handlers and connection handlers
@@ -85,60 +84,39 @@ export function isClosed() {
 let lastManualStopTimestamp: number = 0
 
 export function initialiseSocket({ uri, onOpen, onClose }: InitialiseSocketInput) {
-  if (!uri) {
-    throw 'Must be called with an uri'
-  }
-  webSocket = new WebSocket(uri)
+  webSocket = new ReconnectingWebSocket(uri, [], {
+    WebSocket,
+    maxRetries: 5,
+  })
 
-  webSocket.on('open', () => {
+  webSocket.addEventListener('open', () => {
     webSocketOpen = true
-    onOpen && setTimeout(onOpen!, 0)
+    if (onOpen !== undefined) {
+      setTimeout(onOpen, 0)
+    }
   })
 
-  webSocket.on('close', () => {
+  webSocket.addEventListener('close', () => {
     webSocketOpen = false
     if (lastManualStopTimestamp + 15000 < Date.now()) {
-      // This happends when the connections breaks unintentionally
+      // This happens when the connections breaks unintentionally
       console.log(USER_MESSAGE.CONNECTION_LOST())
-      tryToConnect({ uri, onOpen, onClose }, 5).then(connected => {
-        if (!connected) {
-          console.log(USER_MESSAGE.CONNECTION_LOST_RESTARTING())
-          sendNotification(jobs.Request.internalRestart)
-        }
-      })
       return
     }
-    onClose && setTimeout(onClose!, 0)
+
+    if (onClose !== undefined) {
+      setTimeout(onClose, 0)
+    }
   })
 
-  webSocket.on('message', (data: string) => {
-    const flixResponse: FlixResponse = JSON.parse(data)
-    const job: jobs.EnqueuedJob = jobs.getJob(flixResponse.id)
+  webSocket.addEventListener('message', message => {
+    const flixResponse: FlixResponse = JSON.parse(message.data)
+    const job = jobs.getJob(flixResponse.id)
 
     handleResponse(flixResponse, job)
   })
 }
 
-async function tryToConnect({ uri, onOpen, onClose }: InitialiseSocketInput, times: number) {
-  const uriPort = parseInt(uri.slice(-4))
-  getPort({ port: uriPort }, (err, freePort) => {
-    if (uriPort === freePort) {
-      // This happens if the previously used port is now free
-      sendNotification(jobs.Request.internalRestart)
-      return
-    }
-  })
-  let retries = times
-  while (retries-- > 0) {
-    initialiseSocket({ uri, onOpen, onClose })
-    await sleep(1000)
-    if (webSocketOpen) {
-      return true
-    }
-  }
-  return false
-}
-
 function clearTimer(id: string) {
   clearTimeout(sentMessagesMap[id])
   delete sentMessagesMap[id]

server/src/util/userMessages.ts

@@ -8,10 +8,6 @@ export class USER_MESSAGE {
     return 'Connection to the flix server was lost, trying to reconnect...'
   }
 
-  static CONNECTION_LOST_RESTARTING() {
-    return 'Failed to connect to the flix server, restarting the compiler...'
-  }
-
   static FAILED_TO_START() {
     return 'Failed starting Flix'
   }

server/tsconfig.json

@@ -8,7 +8,9 @@
     "strict": true,
     "outDir": "out",
     "rootDir": "src",
-    "allowJs": true
+    "allowJs": true,
+    "esModuleInterop": true,
+    "skipLibCheck": true
   },
   "include": ["src"],
   "exclude": ["node_modules", ".vscode-test"]