Set up server extension websockets (#14)

* migrate to use ExtensionApp

* remove unused setup_handlers()

* add awareness and ydoc websocket handlers

* rename classes

* add missing files

Author: dlqqq

jupyter_rtc_core/__init__.py

@@ -7,7 +7,8 @@
     import warnings
     warnings.warn("Importing 'jupyter_rtc_core' outside a proper installation.")
     __version__ = "dev"
-from .handlers import setup_handlers
+
+from .app import RtcExtensionApp
 
 
 def _jupyter_labextension_paths():
@@ -19,18 +20,6 @@ def _jupyter_labextension_paths():
 
 def _jupyter_server_extension_points():
     return [{
-        "module": "jupyter_rtc_core"
+        "module": "jupyter_rtc_core",
+        "app": RtcExtensionApp
     }]
-
-
-def _load_jupyter_server_extension(server_app):
-    """Registers the API handler to receive HTTP requests from the frontend extension.
-
-    Parameters
-    ----------
-    server_app: jupyterlab.labapp.LabApp
-        JupyterLab application instance
-    """
-    setup_handlers(server_app.web_app)
-    name = "jupyter_rtc_core"
-    server_app.log.info(f"Registered {name} server extension")

jupyter_rtc_core/app.py

@@ -0,0 +1,16 @@
+from jupyter_server.extension.application import ExtensionApp
+
+from .handlers import RouteHandler
+from .websockets import GlobalAwarenessWebsocket, YRoomWebsocket
+
+class RtcExtensionApp(ExtensionApp):
+    name = "jupyter_rtc_core"
+    handlers = [
+        # dummy handler that verifies the server extension is installed;
+        # this can be deleted prior to initial release.
+        (r"jupyter-rtc-core/get-example/?", RouteHandler),
+        # global awareness websocket
+        (r"api/collaboration/room/JupyterLab:globalAwareness/?", GlobalAwarenessWebsocket),
+        # ydoc websocket
+        (r"api/collaboration/room/(.*)", YRoomWebsocket)
+    ]

jupyter_rtc_core/handlers.py

@@ -1,7 +1,6 @@
 import json
 
 from jupyter_server.base.handlers import APIHandler
-from jupyter_server.utils import url_path_join
 import tornado
 
 class RouteHandler(APIHandler):
@@ -13,12 +12,3 @@ def get(self):
         self.finish(json.dumps({
             "data": "This is /jupyter-rtc-core/get-example endpoint!"
         }))
-
-
-def setup_handlers(web_app):
-    host_pattern = ".*$"
-
-    base_url = web_app.settings["base_url"]
-    route_pattern = url_path_join(base_url, "jupyter-rtc-core", "get-example")
-    handlers = [(route_pattern, RouteHandler)]
-    web_app.add_handlers(host_pattern, handlers)

jupyter_rtc_core/websockets/__init__.py

@@ -0,0 +1,2 @@
+from .global_awareness_ws import GlobalAwarenessWebsocket
+from .yroom_ws import YRoomWebsocket

jupyter_rtc_core/websockets/global_awareness_ws.py

@@ -0,0 +1,4 @@
+from tornado.websocket import WebSocketHandler
+
+class GlobalAwarenessWebsocket(WebSocketHandler):
+    pass

jupyter_rtc_core/websockets/yroom_ws.py

@@ -0,0 +1,4 @@
+from tornado.websocket import WebSocketHandler
+
+class YRoomWebsocket(WebSocketHandler):
+    pass