Add room merging

Author: davidbrochart

jupyverse_api/jupyverse_api/yjs/__init__.py

@@ -1,10 +1,13 @@
+from __future__ import annotations
+
 from abc import ABC, abstractmethod
 from typing import Any
 
 from fastapi import APIRouter, Depends, Request, Response
 
 from jupyverse_api import Router
 
+from .models import MergeRoom
 from ..app import App
 from ..auth import Auth, User
 
@@ -35,13 +38,20 @@ async def create_roomid(
         ):
             return await self.create_roomid(path, request, response, user)
 
-        @router.put("/api/collaboration/room/{roomid}", status_code=201)
+        @router.put("/api/collaboration/fork_room/{roomid}", status_code=201)
         async def fork_room(
             roomid,
             user: User = Depends(auth.current_user(permissions={"contents": ["read"]})),
         ):
             return await self.fork_room(roomid, user)
 
+        @router.put("/api/collaboration/merge_room", status_code=200)
+        async def merge_room(
+            merge_room: MergeRoom,
+            user: User = Depends(auth.current_user(permissions={"contents": ["read"]})),
+        ):
+            return await self.merge_room(merge_room, user)
+
         self.include_router(router)
 
     @abstractmethod
@@ -70,6 +80,14 @@ async def fork_room(
     ):
         ...
 
+    @abstractmethod
+    async def merge_room(
+        self,
+        merge_room: MergeRoom,
+        user: User,
+    ):
+        ...
+
     @abstractmethod
     def get_document(
         self,

jupyverse_api/jupyverse_api/yjs/models.py

@@ -4,3 +4,8 @@
 class CreateDocumentSession(BaseModel):
     format: str
     type: str
+
+
+class MergeRoom(BaseModel):
+    fork_roomid: str
+    root_roomid: str

plugins/yjs/fps_yjs/routes.py

@@ -21,7 +21,7 @@
 from jupyverse_api.auth import Auth, User
 from jupyverse_api.contents import Contents
 from jupyverse_api.yjs import Yjs
-from jupyverse_api.yjs.models import CreateDocumentSession
+from jupyverse_api.yjs.models import CreateDocumentSession, MergeRoom
 
 from .ydocs import ydocs as YDOCS
 from .ydocs.ybasedoc import YBaseDoc
@@ -104,17 +104,27 @@ async def fork_room(
 
         root_room = await self.room_manager.websocket_server.get_room(roomid)
         update = root_room.ydoc.get_update()
-        new_ydoc = Doc()
-        new_ydoc.apply_update(update)
-        new_room = await self.room_manager.websocket_server.get_room(idx, new_ydoc)
-        root_room.local_clients.add(new_room)
+        fork_ydoc = Doc()
+        fork_ydoc.apply_update(update)
+        fork_room = await self.room_manager.websocket_server.get_room(idx, fork_ydoc)
+        root_room.local_clients.add(fork_room)
 
         res = {
             "sessionId": SERVER_SESSION,
             "roomId": idx,
         }
         return res
 
+    async def merge_room(
+        self,
+        merge_room: MergeRoom,
+        user: User,
+    ):
+        fork_room = await self.room_manager.websocket_server.get_room(merge_room.fork_roomid)
+        root_room = await self.room_manager.websocket_server.get_room(merge_room.root_roomid)
+        update = fork_room.ydoc.get_update()
+        root_room.ydoc.apply_update(update)
+
     def get_document(self, document_id: str) -> YBaseDoc:
         return self.room_manager.documents[document_id]
 

tests/test_yjs.py

@@ -10,7 +10,7 @@
 from pycrdt import Doc, Text
 
 from jupyverse_api.main import JupyverseComponent
-from jupyverse_api.yjs.models import CreateDocumentSession
+from jupyverse_api.yjs.models import CreateDocumentSession, MergeRoom
 
 
 @pytest.mark.asyncio
@@ -52,25 +52,42 @@ async def test_fork_room(tmp_path, unused_tcp_port):
                 await sleep(0.1)
                 assert str(root_ytext) == "Hello"
                 # fork room
+                root_roomid = f"text:file:{file_id}"
                 response = await http.put(
-                    f"http://127.0.0.1:{unused_tcp_port}/api/collaboration/room/text:file:{file_id}"
+                    f"http://127.0.0.1:{unused_tcp_port}/api/collaboration/fork_room/{root_roomid}"
                 )
                 r = response.json()
-                fork_room_id = r["roomId"]
+                fork_roomid = r["roomId"]
                 # connect to forked room
                 async with aconnect_ws(
-                    f"http://127.0.0.1:{unused_tcp_port}/api/collaboration/room/{fork_room_id}"
+                    f"http://127.0.0.1:{unused_tcp_port}/api/collaboration/room/{fork_roomid}"
                 ) as fork_ws:
                     # create a forked room client
                     fork_ydoc = Doc()
                     fork_ydoc["source"] = fork_ytext = Text()
-                    async with WebsocketProvider(fork_ydoc, Websocket(fork_ws, fork_room_id)):
+                    async with WebsocketProvider(fork_ydoc, Websocket(fork_ws, fork_roomid)):
                         await sleep(0.1)
                         assert str(fork_ytext) == "Hello"
+                        # check that the forked room is synced with the root room
                         root_ytext += ", World!"
                         await sleep(0.1)
                         assert str(root_ytext) == "Hello, World!"
                         assert str(fork_ytext) == "Hello, World!"
+                        # check that the root room is not synced with the forked room
+                        fork_ytext += " Bye!"
+                        await sleep(0.1)
+                        assert str(root_ytext) == "Hello, World!"
+                        assert str(fork_ytext) == "Hello, World! Bye!"
+                        # merge forked room into root room
+                        merge_room = MergeRoom(fork_roomid=fork_roomid, root_roomid=root_roomid)
+                        response = await http.put(
+                            f"http://127.0.0.1:{unused_tcp_port}/api/collaboration/merge_room",
+                            json=merge_room.model_dump(),
+                        )
+                        # check that the root room is synced with the forked room
+                        await sleep(0.1)
+                        assert str(root_ytext) == "Hello, World! Bye!"
+                        assert str(fork_ytext) == "Hello, World! Bye!"
 
 
 class Websocket: