Support remote directory listing

Author: davidbrochart

plugins/yjs/fps_yjs/ydocs/ydrive.py

@@ -83,8 +83,8 @@ def _callback(self, events):
         for event in events:
             if isinstance(event, MapEvent):
                 current = self._ycontent
-                for path in event.path:
-                    current = current[path]
+                for p in event.path:
+                    current = current[p]
                 for key, val in event.keys.items():
                     action = val.get("action")
                     if action == "delete":
@@ -101,13 +101,17 @@ def _callback(self, events):
                             self._task_group.start_soon(self._try_create_directory, path)
                         else:
                             self._task_group.start_soon(self._try_create_file, path)
+                    elif action == "update":
+                        if key == "populate" and not val["oldValue"] and val["newValue"]:
+                            path = "/".join(event.path[1::2])
+                            self._task_group.start_soon(self.ls, path)
 
     @property
     def version(self) -> str:
         return "1.0.0"
 
     def _new_dir_content(self) -> Map:
-        return Map({"is_dir": True, "content": None})
+        return Map({"is_dir": True, "populate": False, "content": None})
 
     def _new_file_content(self, content: Content | None = None) -> Map:
         if content is None:
@@ -153,7 +157,10 @@ async def _get_directory_content(self, path: Path) -> Map:
 
     async def _maybe_populate_dir(self, path: Path, content: Map):
         if content["content"] is None:
-            content["content"] = await self._get_directory_content(path)
+            with content.doc.transaction():
+                content["content"] = await self._get_directory_content(path)
+                if not content["populate"]:
+                    content["populate"] = True
 
     async def _get(self, path: Path | str | None = None) -> Map:
         path = Path() if path is None else Path(path)

plugins/yjs/tests/test_ydocs.py

@@ -57,6 +57,25 @@ async def test_ydrive():
                 await ydrive.ls("doesnt_exist")
             assert str(exc_info.value) == "404: Item not found"
 
+            # remote ydrive.ls()
+            assert not ydrive._ycontent["populate"]
+            assert ydrive._ycontent["content"] is None
+            ydrive._ycontent["populate"] = True
+            await assert_with_timeout(lambda: ydrive._ycontent["content"] is not None)
+            assert "file0" in ydrive._ycontent["content"]
+            assert "file1" in ydrive._ycontent["content"]
+            assert "dir0" in ydrive._ycontent["content"]
+            assert "dir1" in ydrive._ycontent["content"]
+
+            assert not ydrive._ycontent["content"]["dir0"]["populate"]
+            assert ydrive._ycontent["content"]["dir0"]["content"] is None
+            ydrive._ycontent["content"]["dir0"]["populate"] = True
+            await assert_with_timeout(
+                lambda: ydrive._ycontent["content"]["dir0"]["content"] is not None
+            )
+            assert len(ydrive._ycontent["content"]["dir0"]["content"]) == 1
+            assert "file2" in ydrive._ycontent["content"]["dir0"]["content"]
+
             root_dir = await ydrive.ls()
             assert "file0" in root_dir
             assert "file1" in root_dir