Fix use of traitlets to configure YStore class (jupyterlab#322)

* Fix use of traitlets to configure YStore class

* Add test case, apply fix in the fixture too

Co-authored-by: asteppke <[email protected]>

---------

Co-authored-by: asteppke <[email protected]>

Author: 2 people

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

@@ -3,6 +3,7 @@
 from __future__ import annotations
 
 import asyncio
+from functools import partial
 from typing import Literal
 
 from jupyter_server.extension.application import ExtensionApp
@@ -96,13 +97,12 @@ def initialize_handlers(self):
         page_config.setdefault("serverSideExecution", self.server_side_execution)
 
         # Set configurable parameters to YStore class
-        for k, v in self.config.get(self.ystore_class.__name__, {}).items():
-            setattr(self.ystore_class, k, v)
+        ystore_class = partial(self.ystore_class, config=self.config)
 
         self.ywebsocket_server = JupyterWebsocketServer(
             rooms_ready=False,
             auto_clean_rooms=False,
-            ystore_class=self.ystore_class,
+            ystore_class=ystore_class,
             # Log exceptions, because we don't want the websocket server
             # to _ever_ crash permanently in a live jupyter_server.
             exception_handler=exception_logger,
@@ -131,16 +131,10 @@ def initialize_handlers(self):
                     YDocWebSocketHandler,
                     {
                         "document_cleanup_delay": self.document_cleanup_delay,
-                        "store": self.store,
-                        "room_manager": self.room_manager,
-                    },
-                ),
-                (
-                    r"/api/collaboration/session/(.*)",
-                    DocSessionHandler,
-                    {
-                        "store": self.store,
-                        "room_manager": self.room_manager,
+                        "document_save_delay": self.document_save_delay,
+                        "file_loaders": self.file_loaders,
+                        "ystore_class": ystore_class,
+                        "ywebsocket_server": self.ywebsocket_server,
                     },
                 ),
             ]

tests/conftest.py

@@ -176,13 +176,9 @@ async def _inner(format: str, type: str, path: str) -> None:
     return _inner
 
 
-@pytest.fixture
-def rtc_create_SQLite_store(jp_serverapp):
-    for k, v in jp_serverapp.config.get("SQLiteYStore").items():
-        setattr(SQLiteYStore, k, v)
-
+def rtc_create_SQLite_store_factory(jp_serverapp):
     async def _inner(type: str, path: str, content: str) -> DocumentRoom:
-        db = SQLiteYStore(path=f"{type}:{path}")
+        db = SQLiteYStore(path=f"{type}:{path}", config=jp_serverapp.config)
         task = create_task(db.start())
         await db.started.wait()
 
@@ -201,6 +197,11 @@ async def _inner(type: str, path: str, content: str) -> DocumentRoom:
     return _inner
 
 
+@pytest.fixture
+def rtc_create_SQLite_store(jp_serverapp):
+    return rtc_create_SQLite_store_factory(jp_serverapp)
+
+
 @pytest.fixture
 def rtc_create_mock_document_room():
     def _inner(

tests/test_app.py

@@ -6,6 +6,8 @@
 import pytest
 from jupyter_server_ydoc.stores import SQLiteYStore, TempFileYStore
 
+from .conftest import rtc_create_SQLite_store_factory
+
 
 def test_default_settings(jp_serverapp):
     settings = jp_serverapp.web_app.settings["jupyter_server_ydoc_config"]
@@ -62,6 +64,19 @@ def test_settings_should_change_ystore_class(jp_configurable_serverapp):
     assert settings["ystore_class"] == TempFileYStore
 
 
+async def test_document_ttl_from_settings(rtc_create_mock_document_room, jp_configurable_serverapp):
+    argv = ["--SQLiteYStore.document_ttl=3600"]
+
+    app = jp_configurable_serverapp(argv=argv)
+
+    id = "test-id"
+    content = "test_ttl"
+    rtc_create_SQLite_store = rtc_create_SQLite_store_factory(app)
+    store = await rtc_create_SQLite_store("file", id, content)
+
+    assert store.document_ttl == 3600
+
+
 @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)