Allow to request a document from its document_id/room_id

Author: fcollonval

projects/jupyter-server-ydoc/jupyter_server_ydoc/app.py

@@ -136,21 +136,35 @@ def initialize_handlers(self):
     async def get_document(
         self: YDocExtension,
         *,
-        path: str,
-        content_type: Literal["notebook", "file"],
-        file_format: Literal["json", "text"],
+        path: str | None = None,
+        content_type: str | None = None,
+        file_format: Literal["json", "text"] | None = None,
+        document_id: str | None = None,
         copy: bool = True,
     ) -> YBaseDoc | None:
         """Get a view of the shared model for the matching document.
 
+        You need to provide either a ``document_id`` or the ``path``,
+        the ``content_type`` and the ``file_format``.
+
         If `copy=True`, the returned shared model is a fork, meaning that any changes
          made to it will not be propagated to the shared model used by the application.
         """
-        file_id_manager = self.serverapp.web_app.settings["file_id_manager"]
-        file_id = file_id_manager.index(path)
-
-        encoded_path = encode_file_path(file_format, content_type, file_id)
-        room_id = room_id_from_encoded_path(encoded_path)
+        error_msg = "You need to provide either a ``document_id`` or the ``path``, the ``content_type`` and the ``file_format``."
+        if document_id is None:
+            if path is None or content_type is None or file_format is None:
+                raise ValueError(error_msg)
+
+            file_id_manager = self.serverapp.web_app.settings["file_id_manager"]
+            file_id = file_id_manager.index(path)
+
+            encoded_path = encode_file_path(file_format, content_type, file_id)
+            room_id = room_id_from_encoded_path(encoded_path)
+                
+        elif path is not None or content_type is not None or file_format is not None:
+            raise ValueError(error_msg)
+        else:
+            room_id = document_id
 
         try:
             room = await self.ywebsocket_server.get_room(room_id)
@@ -164,7 +178,7 @@ async def get_document(
                 fork_ydoc = Doc()
                 fork_ydoc.apply_update(update)
 
-                return YDOCS.get(content_type, YDOCS["file"])(fork_ydoc)
+                return YDOCS.get(room.file_type, YDOCS["file"])(fork_ydoc)
             else:
                 return room._document
 

projects/jupyter-server-ydoc/jupyter_server_ydoc/rooms.py

@@ -53,6 +53,16 @@ def __init__(
         self._document.observe(self._on_document_change)
         self._file.observe(self.room_id, self._on_outofband_change)
 
+    @property
+    def file_format(self) -> str:
+        """Document file format."""
+        return self._file_format
+
+    @property
+    def file_type(self) -> str:
+        """Document file type."""
+        return self._file_type
+
     @property
     def room_id(self) -> str:
         """