Add copy argument

Author: krassowski

jupyter_collaboration/app.py

@@ -128,6 +128,7 @@ async def get_document(
         path: str,
         content_type: Literal["notebook", "file"],
         file_format: Literal["json", "text"],
+        copy: bool = True,
     ) -> YBaseDoc | None:
         """Get a read-only view of the shared model for the matching document.
 
@@ -146,7 +147,15 @@ async def get_document(
             return None
 
         if isinstance(room, DocumentRoom):
-            return room._document
+            if copy:
+                update = room.ydoc.get_update()
+
+                fork_ydoc = Doc()
+                fork_ydoc.apply_update(update)
+
+                return YDOCS.get(content_type, YDOCS["file"])(fork_ydoc)
+            else:
+                return room._document
 
         return None
 

tests/test_app.py

@@ -3,6 +3,8 @@
 
 from __future__ import annotations
 
+import pytest
+
 from jupyter_collaboration.stores import SQLiteYStore, TempFileYStore
 
 
@@ -61,9 +63,28 @@ def test_settings_should_change_ystore_class(jp_configurable_serverapp):
     assert settings["ystore_class"] == TempFileYStore
 
 
-async def test_get_document_file(rtc_create_file, jp_serverapp):
+@pytest.mark.parametrize("copy", [True, False])
+async def test_get_document_file(rtc_create_file, jp_serverapp, copy):
     path, content = await rtc_create_file("test.txt", "test", store=True)
     collaboration = jp_serverapp.web_app.settings["jupyter_collaboration"]
-    document = await collaboration.get_document(path=path, content_type="file", file_format="text")
+    document = await collaboration.get_document(
+        path=path, content_type="file", file_format="text", copy=copy
+    )
     assert document.get() == content == "test"
     await collaboration.stop_extension()
+
+
+async def test_get_document_file_copy_is_independent(
+    rtc_create_file, jp_serverapp, rtc_fetch_session
+):
+    path, content = await rtc_create_file("test.txt", "test", store=True)
+    collaboration = jp_serverapp.web_app.settings["jupyter_collaboration"]
+    document = await collaboration.get_document(
+        path=path, content_type="file", file_format="text", copy=True
+    )
+    document.set("other")
+    fresh_copy = await collaboration.get_document(
+        path=path, content_type="file", file_format="text"
+    )
+    assert fresh_copy.get() == "test"
+    await collaboration.stop_extension()