Fix Python backend and update various dependencies (#2411)

dpwatrous · web-flow · commit 00e6978da39d · 2022-02-08T12:28:29.000-08:00
* Remove deprecated Chrome debugger extension from VSCode recommendations * Update to Electron 11 and PyInstaller 4 * Fix broken python websocket server Fixes #2384 A previous dependency update caused an issue between pyinstaller and websockets. Updated both and fixed the issue by changing how websockets is imported.
diff --git a/.gitignore b/.gitignore
@@ -3,6 +3,7 @@ build/
 dll/
 typings/
 logs/
+env/
 *.log*
 *.mem.csv
 release/
diff --git a/.vscode/extensions.json b/.vscode/extensions.json
@@ -2,7 +2,6 @@
   "recommendations": [
     "stylelint.vscode-stylelint",
     "EditorConfig.EditorConfig",
-    "msjsdiag.debugger-for-chrome",
     "dbaeumer.vscode-eslint",
     "esbenp.prettier-vscode",
     "rvest.vs-code-prettier-eslint",
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -101,7 +101,7 @@
     "copy-webpack-plugin": "^6.0.3",
     "cross-env": "^5.2.1",
     "css-loader": "^2.1.1",
-    "electron": "^9.4.0",
+    "electron": "^11.5.0",
     "electron-builder": "22.11.4",
     "eslint": "^7.19.0",
     "eslint-config-prettier": "^7.2.0",
@@ -144,7 +144,7 @@
     "rimraf": "^2.7.1",
     "sass": "^1.26.10",
     "sass-loader": "^9.0.3",
-    "spectron": "^11.1.0",
+    "spectron": "^13.0.0",
     "style-loader": "^0.23.1",
     "stylelint": "^13.6.1",
     "to-string-loader": "^1.1.6",
diff --git a/python/jsonrpc/error.py b/python/jsonrpc/error.py
@@ -1,4 +1,5 @@
 import json
+from typing import Union
 
 
 class JsonRpcErrorCodes:
@@ -25,7 +26,7 @@ class JsonRpcError(BaseException):
         Class representing a JSON rpc error
     """
 
-    def __init__(self, code: str, message: str, data: object = None):
+    def __init__(self, code: Union[str, int], message: str, data: object = None):
         super().__init__()
         self.code = code
         self.message = message
diff --git a/python/jsonrpc/request.py b/python/jsonrpc/request.py
@@ -1,6 +1,7 @@
 import json
 import asyncio
 import threading
+from typing import Any
 from server.aad_auth import AADAuth
 from .error import JsonRpcParseError
 stream_loop = asyncio.new_event_loop()
@@ -33,7 +34,7 @@ class JsonRpcRequest:
     def __init__(self,
                  jsonrpc: str,
                  method: str,
-                 params: any,
+                 params: Any,
                  options: JsonRpcRequestOptions,
                  request_id: str,
                  connection):
@@ -56,7 +57,7 @@ def __init__(self,
         if options.authentication:
             self.auth = AADAuth.from_dict(options.authentication)
 
-    async def send_stream(self, data: any):
+    async def send_stream(self, data: Any):
         from .response import JsonRpcResponse
         response = JsonRpcResponse(
             request=self,
@@ -65,7 +66,7 @@ async def send_stream(self, data: any):
         )
         await self.connection.send_response(response)
 
-    def push_stream(self, data: any):
+    def push_stream(self, data: Any):
         stream_loop.call_soon_threadsafe(
             lambda: stream_loop.create_task(self.send_stream(data)))
 
diff --git a/python/jsonrpc/response.py b/python/jsonrpc/response.py
@@ -1,4 +1,5 @@
 import json
+from typing import Any, Optional
 from .error import JsonRpcError
 from .request import JsonRpcRequest
 
@@ -8,7 +9,7 @@ class JsonRpcResponse:
         Class for a json rpc response.
     """
 
-    def __init__(self, request: JsonRpcRequest, result: any=None, stream=False, error: JsonRpcError=None):
+    def __init__(self, request: Optional[JsonRpcRequest], result: Any=None, stream=False, error: JsonRpcError=None):
         self.jsonrpc = "2.0"
         self.result = result
         self.error = error
diff --git a/python/main.py b/python/main.py
@@ -1,6 +1,7 @@
 # """
 #     Main module
 # """
+import asyncio
 import logging
 import signal
 import sys
@@ -13,7 +14,7 @@ def setup_logging():
     logging.basicConfig(format='%(message)s', level="INFO")
 
 
-def run():
+async def main():
     """
         Main function of the app that start the server
     """
@@ -24,9 +25,9 @@ def run():
         port = int(sys.argv[1])
 
     ws_server = server.websocket_server.WebsocketServer(port)
-    ws_server.run_forever()
+    await ws_server.run_forever()
 
 
 
 if __name__ == "__main__":
-    run()
+    asyncio.run(main())
diff --git a/python/requirements.txt b/python/requirements.txt
@@ -1,5 +1,5 @@
-websockets==9.1
+websockets==10.1
 pylint==2.3.0
 azure-batch-extensions==7.0.0
-pyinstaller==3.6
+pyinstaller==4.9
 azure-batch==8.0.0
diff --git a/python/server/app.py b/python/server/app.py
@@ -1,6 +1,7 @@
 import inspect
 import traceback
 import azext.batch
+from azext.batch.errors import MissingParameterValue
 import azure.batch.models as batch_models
 import azure.common
 import logging
@@ -59,7 +60,7 @@ async def call_procedure(self, request):
             except batch_models.BatchErrorException as e:
                 # pylint: disable=E1101
                 raise JsonRpcError(e.response.status_code, e.message.value, e.response.json())
-            except azext.batch.errors.MissingParameterValue as e:
+            except MissingParameterValue as e:
                 raise JsonRpcInvalidParamsError(str(e), {
                     'paramName': e.parameter_name,
                     'paramDescription': e.parameter_description,
diff --git a/python/server/websocket_server.py b/python/server/websocket_server.py
@@ -1,8 +1,9 @@
 import asyncio
 import traceback
-import websockets
 import logging
 from jsonrpc import JsonRpcRequest, JsonRpcResponse, error
+from websockets import server
+from websockets.exceptions import ConnectionClosed
 from .response_stream import ResponseStream
 from .app import app
 from controllers import *
@@ -14,17 +15,17 @@ class WebsocketServer:
 
     def __init__(self, port):
         self.port = port
-        self.start_server = websockets.serve(
-            self.handler, "localhost", self.port)
+        self.start_server = server.serve(
+            self.handler, "127.0.0.1", self.port)
 
-    def run_forever(self):
+    async def run_forever(self):
         """
             Start to serve the server forever.
         """
         print("Starting websocket server...")
-        asyncio.get_event_loop().run_until_complete(self.start_server)
-        print("Started server")
-        asyncio.get_event_loop().run_forever()
+        async with server.serve(self.handler, "127.0.0.1", self.port):
+            print("Started server")
+            await asyncio.Future()
 
     async def handler(self, websocket, _):
         """
@@ -33,7 +34,7 @@ async def handler(self, websocket, _):
         connection = WebsocketConnection(websocket)
         try:
             await connection.listen()
-        except websockets.exceptions.ConnectionClosed:
+        except ConnectionClosed:
             logging.info("Websocket connection closed.")
 
 
@@ -54,7 +55,7 @@ async def listen(self):
                     error=parse_error,
                 )
                 await self.send_response(response)
-            except websockets.exceptions.ConnectionClosed:
+            except ConnectionClosed:
                 logging.info("Websocket connection closed.")
             else:
                 await self.process_request(request)
diff --git a/src/client/startup.ts b/src/client/startup.ts
@@ -28,7 +28,7 @@ function setupSingleInstance(batchExplorerApp: BatchExplorerApplication) {
         log.info("There is already an instance of BatchExplorer open. Closing this one.");
         batchExplorerApp.quit();
     } else {
-        app.on("second-instance", (event, commandLine, workingDirectory) => {
+        app.on("second-instance", (event, commandLine) => {
             log.info("Try to open labs again", commandLine);
             batchExplorerApp.openFromArguments(commandLine);
         });
@@ -40,7 +40,7 @@ function registerAuthProtocol() {
     // This call needs to be done after electron app is ready.
     protocol.registerStringProtocol("urn", (request, callback) => {
         // Doesn't matter how the protocol is handled; error is fine
-        callback();
+        callback("");
     });
 }
 
@@ -128,7 +128,7 @@ function secureRemoteContentLoading() {
 
     // This reject any permissions requested by remove websites(Like asking for location).
     // This should never get called as the above call shouldn't open any remote links
-    session.defaultSession!.setPermissionRequestHandler((webContents, permission, callback) => {
+    session.defaultSession.setPermissionRequestHandler((webContents, permission, callback) => {
         return callback(false);
     });
 }
diff --git a/test/spectron/test-app-start.spec.ts b/test/spectron/test-app-start.spec.ts
@@ -17,7 +17,9 @@ describe("Bundled application is starting correctly", () => {
 
         await app.start();
         // eslint-disable-next-line no-console
-        console.log("User path: ", await app.electron.remote.app.getPath("userData"));
+        // TODO: Why did the typings break in spectron 13?
+        const electron = app.electron as unknown as any;
+        console.log("User path: ", await electron.remote.app.getPath("userData"));
     });
 
     afterEach(() => {
