Merge pull request #3 from davidbrochart/tests

Add test

Author: davidbrochart

.github/workflows/test.yml

@@ -48,5 +48,9 @@ jobs:
           python-version: "3.7"
       - name: Install dependencies
         run: |
-          mamba install python=${{ matrix.python-version }} pip
+          mamba install python=${{ matrix.python-version }} pip nodejs
           pip install .[test]
+          cd tests; npm install
+      - name: Run tests
+        run: |
+          pytest -v

README.md

@@ -8,9 +8,18 @@ documents used in the Jupyter ecosystem. Built-in documents include:
 - `YFile`: a generic text document.
 - `YNotebook`: a Jupyter notebook document.
 
-These documents are registered in an entry point under the `jupyter_ydoc` group as `"file"` and
+These documents are registered via an entry point under the `"jupyter_ydoc"` group as `"file"` and
 `"notebook"`, respectively. You can access them as follows:
 
+```py
+from jupyter_ydoc import ydocs
+
+print(ydocs)
+# {'file': <class 'jupyter_ydoc.ydoc.YFile'>, 'notebook': <class 'jupyter_ydoc.ydoc.YNotebook'>}
+```
+
+Which is just a shortcut to:
+
 ```py
 import sys
 import jupyter_ydoc
@@ -22,8 +31,11 @@ else:
     from importlib.metadata import entry_points
 
 ydocs = {ep.name: ep.load() for ep in entry_points(group="jupyter_ydoc")}
-print(ydocs)
-# {'file': <class 'jupyter_ydoc.ydoc.YFile'>, 'notebook': <class 'jupyter_ydoc.ydoc.YNotebook'>}
+```
+
+Or directly import them:
+```py
+from jupyter_ydoc import YFile, YNotebook
 ```
 
 The `jupyter_ydoc` entry point group can be populated with your own document, e.g. by adding the

jupyter_ydoc/__init__.py

@@ -1 +1,14 @@
+import sys
+
+from .ydoc import YFile, YNotebook  # noqa
+
+# See compatibility note on `group` keyword in
+# https://docs.python.org/3/library/importlib.metadata.html#entry-points
+if sys.version_info < (3, 10):
+    from importlib_metadata import entry_points
+else:
+    from importlib.metadata import entry_points
+
+ydocs = {ep.name: ep.load() for ep in entry_points(group="jupyter_ydoc")}
+
 __version__ = "0.1.0"

jupyter_ydoc/utils.py

@@ -0,0 +1,17 @@
+from typing import Dict, List, Union
+
+
+def cast_all(o: Union[List, Dict], from_type, to_type) -> Union[List, Dict]:
+    if isinstance(o, list):
+        for i, v in enumerate(o):
+            if isinstance(v, from_type):
+                o[i] = to_type(v)
+            elif isinstance(v, (list, dict)):
+                cast_all(v, from_type, to_type)
+    elif isinstance(o, dict):
+        for k, v in o.items():
+            if isinstance(v, from_type):
+                o[k] = to_type(v)
+            elif isinstance(v, (list, dict)):
+                cast_all(v, from_type, to_type)
+    return o

jupyter_ydoc/ydoc.py

@@ -1,9 +1,11 @@
-from typing import Dict, List, Union
+import copy
 from uuid import uuid4
 
 import y_py as Y
 from ypy_websocket.websocket_server import YDoc
 
+from .utils import cast_all
+
 
 class YBaseDoc:
     def __init__(self, ydoc: YDoc):
@@ -96,9 +98,10 @@ def source(self):
 
     @source.setter
     def source(self, value):
-        cast_all(value, int, float)
-        if not value["cells"]:
-            value["cells"] = [
+        nb = copy.deepcopy(value)
+        cast_all(nb, int, float)
+        if not nb["cells"]:
+            nb["cells"] = [
                 {
                     "cell_type": "code",
                     "execution_count": None,
@@ -122,7 +125,7 @@ def source(self, value):
 
             # initialize document
             ycells = []
-            for cell in value["cells"]:
+            for cell in nb["cells"]:
                 cell_source = cell["source"]
                 if cell_source:
                     ytext = Y.YText(cell_source)
@@ -137,9 +140,9 @@ def source(self, value):
 
             if ycells:
                 self._ycells.push(t, ycells)
-            self._ymeta.set(t, "metadata", value["metadata"])
-            self._ystate.set(t, "nbformat", value["nbformat"])
-            self._ystate.set(t, "nbformatMinor", value["nbformat_minor"])
+            self._ymeta.set(t, "metadata", nb["metadata"])
+            self._ystate.set(t, "nbformat", nb["nbformat"])
+            self._ystate.set(t, "nbformatMinor", nb["nbformat_minor"])
         with self._ydoc.begin_transaction() as t:
             for ytext in ytexts_to_clear:
                 ytext.delete(t, 0, 1)
@@ -153,18 +156,3 @@ def observe(self, callback):
             self._subscriptions[cell] = cell.observe(callback)
         self._subscriptions[self._ycells] = self._ycells.observe(callback)
         self._subscriptions[self._ymeta] = self._ymeta.observe(callback)
-
-
-def cast_all(o: Union[List, Dict], from_type, to_type) -> None:
-    if isinstance(o, list):
-        for i, v in enumerate(o):
-            if isinstance(v, from_type):
-                o[i] = to_type(v)
-            elif isinstance(v, (list, dict)):
-                cast_all(v, from_type, to_type)
-    elif isinstance(o, dict):
-        for k, v in o.items():
-            if isinstance(v, from_type):
-                o[k] = to_type(v)
-            elif isinstance(v, (list, dict)):
-                cast_all(v, from_type, to_type)

pytest.ini

@@ -0,0 +1,2 @@
+[pytest]
+asyncio_mode = auto

setup.cfg

@@ -26,6 +26,9 @@ install_requires =
 [options.extras_require]
 test =
   pre-commit
+  pytest
+  pytest-asyncio
+  websockets >=10.0
 
 [options.entry_points]
 jupyter_ydoc =

tests/conftest.py

@@ -0,0 +1,50 @@
+import json
+import subprocess
+from pathlib import Path
+
+import pytest
+from websockets import serve  # type: ignore
+from ypy_websocket import WebsocketServer
+
+# workaround until these PRs are merged:
+# - https://github.com/jupyterlab/jupyterlab/pull/12519
+# - https://github.com/yjs/y-websocket/pull/104
+
+
+def update_json_file(path: Path, d: dict):
+    with open(path, "rb") as f:
+        package_json = json.load(f)
+    package_json.update(d)
+    with open(path, "wt") as f:
+        json.dump(package_json, f, indent=2)
+
+
+here = Path(__file__).parent
+d = {"type": "module"}
+update_json_file(here / "node_modules/@jupyterlab/shared-models/package.json", d)
+update_json_file(here / "node_modules/y-websocket/package.json", d)
+
+
+@pytest.fixture
+async def yws_server(request):
+    try:
+        kwargs = request.param
+    except Exception:
+        kwargs = {}
+    websocket_server = WebsocketServer(**kwargs)
+    async with serve(websocket_server.serve, "localhost", 1234):
+        yield websocket_server
+
+
+@pytest.fixture
+def yjs_client(request):
+    client_id = request.param
+    p = subprocess.Popen(
+        [
+            "node",
+            "--experimental-specifier-resolution=node",
+            f"{here / 'yjs_client_'}{client_id}.js",
+        ]
+    )
+    yield p
+    p.kill()

tests/files/nb0.ipynb

@@ -0,0 +1,33 @@
+{
+    "cells": [
+        {
+            "cell_type": "code",
+            "source": "print('Hello, World!')",
+            "metadata": {},
+            "outputs": [],
+            "execution_count": null,
+            "id": null
+        }
+    ],
+    "metadata": {
+        "kernelspec": {
+            "display_name": "Python 3 (ipykernel)",
+            "language": "python",
+            "name": "python3"
+        },
+        "language_info": {
+            "codemirror_mode": {
+                "name": "ipython",
+                "version": 3
+            },
+            "file_extension": ".py",
+            "mimetype": "text/x-python",
+            "name": "python",
+            "nbconvert_exporter": "python",
+            "pygments_lexer": "ipython3",
+            "version": "3.10.2"
+        }
+    },
+    "nbformat": 4,
+    "nbformat_minor": 5
+}

tests/package.json

@@ -0,0 +1,8 @@
+{
+  "type": "module",
+  "dependencies": {
+    "@jupyterlab/shared-models": "^3.3.4",
+    "ws": "^8.5.0",
+    "y-websocket": "^1.4.1"
+  }
+}