Add fork_room and merge_room handlers

Author: davidbrochart

jupyter_collaboration/app.py

@@ -8,7 +8,7 @@
 from pycrdt_websocket.ystore import BaseYStore
 from traitlets import Bool, Float, Type
 
-from .handlers import DocSessionHandler, YDocWebSocketHandler
+from .handlers import DocForkHandler, DocMergeHandler, DocSessionHandler, YDocWebSocketHandler
 from .loaders import FileLoaderMapping
 from .stores import SQLiteYStore
 from .utils import EVENTS_SCHEMA_PATH
@@ -108,6 +108,20 @@ def initialize_handlers(self):
                     },
                 ),
                 (r"/api/collaboration/session/(.*)", DocSessionHandler),
+                (
+                    r"/api/collaboration/fork_room/(.*)",
+                    DocForkHandler,
+                    {
+                        "ywebsocket_server": self.ywebsocket_server,
+                    }
+                ),
+                (
+                    r"/api/collaboration/merge_room",
+                    DocMergeHandler,
+                    {
+                        "ywebsocket_server": self.ywebsocket_server,
+                    }
+                ),
             ]
         )
 

jupyter_collaboration/handlers.py

@@ -6,12 +6,13 @@
 import asyncio
 import json
 import time
-import uuid
+from uuid import uuid4
 from typing import Any
 
 from jupyter_server.auth import authorized
 from jupyter_server.base.handlers import APIHandler, JupyterHandler
 from jupyter_ydoc import ydocs as YDOCS
+from pycrdt import Doc
 from pycrdt_websocket.websocket_server import YRoom
 from pycrdt_websocket.ystore import BaseYStore
 from pycrdt_websocket.yutils import YMessageType, write_var_uint
@@ -30,7 +31,7 @@
 
 YFILE = YDOCS["file"]
 
-SERVER_SESSION = str(uuid.uuid4())
+SERVER_SESSION = str(uuid4())
 
 
 class YDocWebSocketHandler(WebSocketHandler, JupyterHandler):
@@ -381,3 +382,66 @@ async def put(self, path):
         )
         self.set_status(201)
         return self.finish(data)
+
+
+class DocForkHandler(APIHandler):
+    """
+    Jupyter Server's handler to fork a document.
+    """
+
+    auth_resource = "contents"
+
+    def initialize(
+        self,
+        ywebsocket_server: JupyterWebsocketServer,
+    ) -> None:
+        self._websocket_server = ywebsocket_server
+
+    @web.authenticated
+    @authorized
+    async def put(self, room_id):
+        """
+        Creates a fork of a root document and returns its ID.
+        """
+        idx = uuid4().hex
+
+        root_room = await self._websocket_server.get_room(room_id)
+        update = root_room.ydoc.get_update()
+        fork_ydoc = Doc()
+        fork_ydoc.apply_update(update)
+        fork_room = YRoom(fork_ydoc)
+        self._websocket_server.add_room(idx, fork_room)
+        root_room.fork_ydocs.add(fork_ydoc)
+        data = json.dumps({
+            "sessionId": SERVER_SESSION,
+            "roomId": idx,
+        })
+        self.set_status(201)
+        return self.finish(data)
+
+
+class DocMergeHandler(APIHandler):
+    """
+    Jupyter Server's handler to merge a document.
+    """
+
+    auth_resource = "contents"
+
+    def initialize(
+        self,
+        ywebsocket_server: JupyterWebsocketServer,
+    ) -> None:
+        self._websocket_server = ywebsocket_server
+
+    @web.authenticated
+    @authorized
+    async def put(self):
+        """
+        Merges back a fork into a root document.
+        """
+        model = self.get_json_body()
+        fork_room = await self._websocket_server.get_room(model["fork_roomid"])
+        root_room = await self._websocket_server.get_room(model["root_roomid"])
+        update = fork_room.ydoc.get_update()
+        root_room.ydoc.apply_update(update)
+        self.set_status(200)

packages/collaboration-extension/src/collaboration.ts

@@ -247,6 +247,7 @@ export class EditingModeExtension implements DocumentRegistry.IWidgetExtension<N
     const suggestionMenu = new Menu({ commands: suggestionCommands });
     const reviewMenu = new Menu({ commands: reviewCommands });
 
+    const sharedModel = context.model.sharedModel;
     var myForkId = '';  // curently allows only one suggestion per user
 
     editingMenu.title.label = 'Editing';
@@ -263,6 +264,7 @@ export class EditingModeExtension implements DocumentRegistry.IWidgetExtension<N
       execute: () => {
         editingMenu.title.label = 'Editing';
         suggestionMenu.title.label = 'Root';
+        open_dialog('Editing', this._trans);
       }
     });
     editingCommands.addCommand('suggesting', {
@@ -272,17 +274,17 @@ export class EditingModeExtension implements DocumentRegistry.IWidgetExtension<N
         reviewMenu.clearItems();
         if (myForkId === '') {
           myForkId = 'pending';
-          const provider = context.model.sharedModel.provider;
-          provider.fork().then(newForkId => {
+          sharedModel.provider.fork().then(newForkId => {
             myForkId = newForkId;
-            provider.connectFork(newForkId);
+            sharedModel.provider.connectFork(newForkId);
             suggestionMenu.title.label = newForkId;
           });
         }
         else {
           suggestionMenu.title.label = myForkId;
-          context.model.sharedModel.provider.connectFork(myForkId);
+          sharedModel.provider.connectFork(myForkId);
         }
+        open_dialog('Suggesting', this._trans);
       }
     });
 
@@ -293,14 +295,15 @@ export class EditingModeExtension implements DocumentRegistry.IWidgetExtension<N
         reviewMenu.clearItems();
         suggestionMenu.title.label = 'Root';
         editingMenu.title.label = 'Editing';
-        context.model.sharedModel.provider.connectFork(context.model.sharedModel.rootRoomId);
+        sharedModel.provider.connectFork(sharedModel.rootRoomId);
+        open_dialog('Editing', this._trans);
       }
     });
 
     reviewCommands.addCommand('merge', {
       label: 'Merge',
       execute: () => {
-        requestDocMerge(context.model.sharedModel.currentRoomId, context.model.sharedModel.rootRoomId);
+        requestDocMerge(sharedModel.currentRoomId, sharedModel.rootRoomId);
       }
     });
     reviewCommands.addCommand('discard', {
@@ -336,29 +339,24 @@ export class EditingModeExtension implements DocumentRegistry.IWidgetExtension<N
                   reviewMenu.addItem({type: 'command', command: 'discard'});
                 }
                 suggestionMenu.title.label = newForkId;
-                context.model.sharedModel.provider.connectFork(newForkId);
-                const dialog = new Dialog({
-                  title: this._trans.__('Suggestion'),
-                  body: this._trans.__('Your are now viewing the suggestion.'),
-                  buttons: [Dialog.okButton({ label: 'OK' })],
-                });
-                dialog.launch().then(resp => { dialog.close(); });
+                sharedModel.provider.connectFork(newForkId);
+                open_dialog('Suggesting', this._trans);
               }
             });
             suggestionMenu.addItem({type: 'command', command: newForkId});
             if ((myForkId !== 'pending') && (myForkId !== newForkId)) {
               const dialog = new Dialog({
                 title: this._trans.__('New suggestion'),
-                body: this._trans.__('Open notebook for suggestion?'),
+                body: this._trans.__('View suggestion?'),
                 buttons: [
-                  Dialog.okButton({ label: 'Open' }),
+                  Dialog.okButton({ label: 'View' }),
                   Dialog.cancelButton({ label: 'Discard' }),
                 ],
               });
               dialog.launch().then(resp => {
                 dialog.close();
-                if (resp.button.label === 'Open') {
-                  context.model.sharedModel.provider.connectFork(newForkId);
+                if (resp.button.label === 'View') {
+                  sharedModel.provider.connectFork(newForkId);
                   suggestionMenu.title.label = newForkId;
                   editingMenu.title.label = 'Editing';
                   reviewMenu.clearItems();
@@ -372,7 +370,7 @@ export class EditingModeExtension implements DocumentRegistry.IWidgetExtension<N
       }
     };
 
-    context.model.sharedModel.changed.connect(_onStateChanged, this);
+    sharedModel.changed.connect(_onStateChanged, this);
 
     editingMenubar.addMenu(editingMenu);
     suggestionMenubar.addMenu(suggestionMenu);
@@ -388,3 +386,20 @@ export class EditingModeExtension implements DocumentRegistry.IWidgetExtension<N
     });
   }
 }
+
+
+function open_dialog(title: string, trans: TranslationBundle) {
+  var body: string;
+  if (title === 'Editing') {
+    body = 'You are now directly editing the document.'
+  }
+  else {
+    body = 'Your edits now become suggestions to the document.'
+  }
+  const dialog = new Dialog({
+    title: trans.__(title),
+    body: trans.__(body),
+    buttons: [Dialog.okButton({ label: 'OK' })],
+  });
+  dialog.launch().then(resp => { dialog.close(); });
+}

packages/collaboration/style/base.css

@@ -9,22 +9,3 @@
 .jp-shared-link-body {
     user-select: none;
 }
-
-.jp-EditingMode {
-  display: flex;
-  flex-direction: column;
-  align-items: center;
-  justify-content: center;
-}
-
-.jp-EditingMode .lm-MenuBar-itemIcon svg {
-  vertical-align: sub;
-}
-
-.jp-nb-editing-mode-button > .jp-ToolbarButtonComponent::part(content) {
-  flex-direction: row-reverse;
-}
-
-.jp-nb-editing-mode-button > .jp-ToolbarButtonComponent > svg {
-  padding-left: 3px;
-}